Error 스키마
Error 스키마
모든 비-2xx 응답에서 반환되는 오류 봉투(envelope)예요.
출처: 문서
본문
스키마 — Error · 유형: object
모든 비-2xx 응답에서 반환되는 오류 봉투(envelope)예요.
error · 필수 — 유형: object — 오류 세부 정보.
code · 필수 — 유형: string — 기계가 읽을 수 있는 오류 코드.
not_found: 요청된 리소스가 존재하지 않거나, 조직이 존재하지 않거나, 호출자가 조직의 구성원이 아님(조직의 존재는 접근할 수 없는 호출자에게 드러나지 않아요).conflict: 같은 이름의 리소스가 이미 존재함.invalid_argument: 요청 본문이 잘못되었거나 검증에 실패함.unauthenticated: 자격 증명 누락 또는 유효하지 않음.permission_denied: 조직이 governance를 사용할 자격이 없음.limit_exceeded: 조직이 최대 정책 수에 도달했거나, 정책이 최대 규칙 수에 도달했음.unimplemented: 엔드포인트나 기능이 아직 사용할 수 없음.internal: 예상치 못한 서버 오류.
{
"description": "Machine-readable error code. `not_found`: the requested resource does not exist, the org does not exist, or the caller is not a member of the organization (the organization's existence is not revealed to callers who cannot access it). `conflict`: a resource with the same name already exists. `invalid_argument`: the request body is malformed or fails validation. `unauthenticated`: missing or invalid credentials. `permission_denied`: the org is not entitled to use governance. `limit_exceeded`: the org has reached its maximum number of policies, or the policy has reached its maximum number of rules. `unimplemented`: the endpoint or feature is not yet available. `internal`: unexpected server error.\n",
"enum": [
"not_found",
"conflict",
"invalid_argument",
"unauthenticated",
"permission_denied",
"limit_exceeded",
"unimplemented",
"internal"
],
"type": "string"
}
message · 필수 — 유형: string
{
"type": "string"
}
전체 스키마:
{
"description": "Error envelope returned on all non-2xx responses.",
"properties": {
"error": {
"description": "Error detail.",
"examples": [
{
"code": "not_found",
"message": "policy not found"
}
],
"properties": {
"code": {
"description": "Machine-readable error code. `not_found`: the requested resource does not exist, the org does not exist, or the caller is not a member of the organization (the organization's existence is not revealed to callers who cannot access it). `conflict`: a resource with the same name already exists. `invalid_argument`: the request body is malformed or fails validation. `unauthenticated`: missing or invalid credentials. `permission_denied`: the org is not entitled to use governance. `limit_exceeded`: the org has reached its maximum number of policies, or the policy has reached its maximum number of rules. `unimplemented`: the endpoint or feature is not yet available. `internal`: unexpected server error.\n",
"enum": [
"not_found",
"conflict",
"invalid_argument",
"unauthenticated",
"permission_denied",
"limit_exceeded",
"unimplemented",
"internal"
],
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
}
},
"required": [
"error"
],
"type": "object"
}