Testing Data Transfer to an OBS Bucket
Function
This API is used to check whether data can be transferred to the configured OBS bucket.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
cts:tracker:list
List
-
-
-
obs:bucket:ListAllMyBuckets
URI
POST /v3/{domain_id}/checkbucket
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain_id |
Yes |
String |
Account ID. For details, see Obtaining an Account ID and Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
buckets |
No |
Array of CheckBucketRequest objects |
List of OBS buckets to be checked. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
bucket_name |
Yes |
String |
OBS bucket name. A name contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, numbers, hyphens (-), and periods (.) are allowed. |
|
bucket_location |
Yes |
String |
OBS bucket location. |
|
kms_id |
No |
String |
Key ID used for encrypting transferred trace files. This parameter is mandatory when is_support_trace_files_encryption is set to true. |
|
is_support_trace_files_encryption |
No |
Boolean |
Whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used with kms_id. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
buckets |
Array of Bucket objects |
Response body for checking the OBS bucket status. |
|
Parameter |
Type |
Description |
|---|---|---|
|
bucket_name |
String |
OBS bucket name. A name contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, numbers, hyphens (-), and periods (.) are allowed. |
|
bucket_location |
String |
Bucket location. |
|
kms_id |
String |
Key ID used for transferring and encrypting trace files. This parameter is mandatory when is_support_trace_files_encryption is set to true. |
|
is_support_trace_files_encryption |
Boolean |
Whether transferred trace files are encrypted. This parameter must be used with kms_id. |
|
check_bucket_response |
CheckBucketResponse object |
Check result of the OBS bucket. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_message |
String |
Error message. |
|
response_code |
Integer |
Returned HTTP status code. |
|
success |
Boolean |
Whether the transfer is successful. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. Format: CTS.XXX. |
|
error_msg |
String |
Error message. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. Format: CTS.XXX. |
|
error_msg |
String |
Error message. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. Format: CTS.XXX. |
|
error_msg |
String |
Error message. |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. Format: CTS.XXX. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. Format: CTS.XXX. |
|
error_msg |
String |
Error message. |
Status code: 503
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. Format: CTS.XXX. |
|
error_msg |
String |
Error message. |
Example Requests
Example request body for checking the OBS bucket status
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"
} ]
}
Example Responses
Status code: 200
Request succeeded.
{
"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"
} ]
}
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cts.v3.region.CtsRegion; import com.huaweicloud.sdk.cts.v3.*; import com.huaweicloud.sdk.cts.v3.model.*; import java.util.List; import java.util.ArrayList; public class CheckObsBucketsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CtsClient client = CtsClient.newBuilder() .withCredential(auth) .withRegion(CtsRegion.valueOf("<YOUR REGION>")) .build(); CheckObsBucketsRequest request = new CheckObsBucketsRequest(); request.withDomainId("{domain_id}"); CheckObsBucketsRequestBody body = new CheckObsBucketsRequestBody(); List<CheckBucketRequest> listbodyBuckets = new ArrayList<>(); listbodyBuckets.add( new CheckBucketRequest() .withBucketName("bucket1") .withBucketLocation("cn-north-1") .withKmsId("1f26f8d8-65d4-436b-bea2-bd0ac1984f71") .withIsSupportTraceFilesEncryption(false) ); listbodyBuckets.add( new CheckBucketRequest() .withBucketName("bucket2") .withBucketLocation("cn-north-2") .withKmsId("0c1b7d87-5186-411a-86ce-ed3b2ec848c9") .withIsSupportTraceFilesEncryption(false) ); body.withBuckets(listbodyBuckets); request.withBody(body); try { CheckObsBucketsResponse response = client.checkObsBuckets(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcts.v3.region.cts_region import CtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcts.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CheckObsBucketsRequest() request.domain_id = "{domain_id}" listBucketsbody = [ CheckBucketRequest( bucket_name="bucket1", bucket_location="cn-north-1", kms_id="1f26f8d8-65d4-436b-bea2-bd0ac1984f71", is_support_trace_files_encryption=False ), CheckBucketRequest( bucket_name="bucket2", bucket_location="cn-north-2", kms_id="0c1b7d87-5186-411a-86ce-ed3b2ec848c9", is_support_trace_files_encryption=False ) ] request.body = CheckObsBucketsRequestBody( buckets=listBucketsbody ) response = client.check_obs_buckets(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cts/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cts.NewCtsClient( cts.CtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CheckObsBucketsRequest{} request.DomainId = "{domain_id}" kmsIdBuckets:= "1f26f8d8-65d4-436b-bea2-bd0ac1984f71" isSupportTraceFilesEncryptionBuckets:= false kmsIdBuckets1:= "0c1b7d87-5186-411a-86ce-ed3b2ec848c9" isSupportTraceFilesEncryptionBuckets1:= false var listBucketsbody = []model.CheckBucketRequest{ { BucketName: "bucket1", BucketLocation: "cn-north-1", KmsId: &kmsIdBuckets, IsSupportTraceFilesEncryption: &isSupportTraceFilesEncryptionBuckets, }, { BucketName: "bucket2", BucketLocation: "cn-north-2", KmsId: &kmsIdBuckets1, IsSupportTraceFilesEncryption: &isSupportTraceFilesEncryptionBuckets1, }, } request.Body = &model.CheckObsBucketsRequestBody{ Buckets: &listBucketsbody, } response, err := client.CheckObsBuckets(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
|
400 |
The server failed to process the request. |
|
401 |
The request is rejected due to authentication failure. |
|
403 |
The server understood the request but refused to authorize it. |
|
404 |
The requested resource does not exist. |
|
500 |
Failed to complete the request because of an internal service error. |
|
503 |
The requested service is invalid. The client should not repeat the request without modifications. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot