检查已经配置OBS桶是否可以成功转储
功能介绍
检查已经配置OBS桶是否可以成功转储。
调用方法
请参见如何调用API。
URI
POST /v3/{domain_id}/checkbucket
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain_id |
是 |
String |
账户id，参见获取账号ID和项目ID章节。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
buckets |
否 |
Array of CheckBucketRequest objects |
请求检查的OBS桶列表。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
bucket_name |
是 |
String |
标识OBS桶名称。由数字或字母开头，支持小写字母、数字、“-”、“.”，长度为3～63个字符。 |
|
bucket_location |
是 |
String |
标识OBS桶位置。 |
|
kms_id |
否 |
String |
事件文件转储加密所采用的秘钥id，is_support_trace_files_encryption"参数值为“是”时，此参数为必选项。 |
|
is_support_trace_files_encryption |
否 |
Boolean |
事件文件转储加密功能开关。 该参数必须与kms_id参数同时使用。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
buckets |
Array of Bucket objects |
检查OBS桶状态响应体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bucket_name |
String |
标识OBS桶名称。由数字或字母开头，支持小写字母、数字、“-”、“.”，长度为3～63个字符。 |
|
bucket_location |
String |
标识桶位置。 |
|
kms_id |
String |
事件文件转储加密所采用的秘钥id。 如果is_support_trace_files_encryption"参数值为“是”时，此参数为必选项。 |
|
is_support_trace_files_encryption |
Boolean |
事件文件转储加密功能开关。 该参数必须与kms_id参数同时使用。 |
|
check_bucket_response |
CheckBucketResponse object |
转储OBS桶的检查结果。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_message |
String |
错误信息。 |
|
response_code |
Integer |
返回的http状态码。 |
|
success |
Boolean |
是否成功转储。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
状态码： 503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码标识，CTS.XXX。 |
|
error_msg |
String |
错误描述。 |
请求示例
检查obs桶状态请求体示例
POST https://{endpoint}/v3/{domain_id}/checkbucket
{
"buckets" : [ {
"bucket_location" : "cn-north-1",
"bucket_name" : "bucket1",
"is_support_trace_files_encryption" : false,
"kms_id" : "1f26f8d8-65d4-436b-bea2-bd0ac1984f71"
}, {
"bucket_location" : "cn-north-2",
"bucket_name" : "bucket2",
"is_support_trace_files_encryption" : false,
"kms_id" : "0c1b7d87-5186-411a-86ce-ed3b2ec848c9"
} ]
}
响应示例
状态码： 200
请求成功。
{
"buckets" : [ {
"bucket_location" : "cn-north-1",
"bucket_name" : "bucket1",
"check_bucket_response" : {
"response_code" : 200,
"success" : true
},
"is_support_trace_files_encryption" : false,
"kms_id" : "1f26f8d8-65d4-436b-bea2-bd0ac1984f71"
}, {
"bucket_location" : "cn-north-2",
"bucket_name" : "bucket2",
"check_bucket_response" : {
"error_code" : "OBS.NoSuchBucket",
"error_message" : "Error message:Request Error.OBS service Error Message.",
"response_code" : 404,
"success" : false
},
"is_support_trace_files_encryption" : false,
"kms_id" : "0c1b7d87-5186-411a-86ce-ed3b2ec848c9"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
服务器未能处理请求。 |
|
401 |
请求鉴权校验失败，访问被拒绝。 |
|
403 |
请求权限校验失败，访问被禁止。 |
|
404 |
请求资源不存在，请求未完成。 |
|
500 |
服务内部异常，请求未完成。 |
|
503 |
被请求的服务无效。建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
