# 查询OBS桶列表 - ListObsBuckets #### 功能介绍 查询OBS桶列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-kafka/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-kafka/api-grant-policy.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1.0/dms/obs/buckets #### 请求参数 无 #### 响应参数 **状态码：200** 表1响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [ObsBucketEntity] objects | Obs桶查询列表 | 表2ObsBucketEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | responseHeaders | Object | **参数解释**： 响应头。 | | originalHeaders | Object | **参数解释**： 原始响应头。 | | statusCode | Integer | **参数解释**： 状态码。 **取值范围**： 不涉及。 | | bucketName | String | **参数解释**： 桶名。 **取值范围**： 不涉及。 | | owner | Object | **参数解释**： 桶拥有者信息。 | | creationDate | Long | **参数解释**： 桶的创建时间。 **取值范围**： 不涉及。 | | location | String | **参数解释**： 桶所在的区域。 **取值范围**： 不涉及。 | | clustertype | String | **参数解释**： 集群类型。 **取值范围**： 不涉及。 | | storageClass | String | **参数解释**： 存储类型。 **取值范围**： 不涉及。 | | metadata | Object | **参数解释**： 元数据。 | | acl | String | **参数解释**： 桶ACL策略。 **取值范围**： 不涉及。 | | bucketStorageClass | String | **参数解释**： 桶的存储类型。 **取值范围**： - STANDARD：标准存储。 - WARM：低频访问存储。 - COLD：归档存储。 - DEEP_ARCHIVE：深度归档存储（受限公测）。 | | bucketType | String | **参数解释**： 桶类型。 **取值范围**： 不涉及。 | | requestId | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v1.0/dms/obs/buckets ``` #### 响应示例 **状态码：200** 查询OBS桶列表成功。 ``` [ { "responseHeaders" : { }, "originalHeaders" : { }, "statusCode" : 200, "bucketName" : "test", "owner" : { }, "creationDate" : 1597993512727, "location" : "xx-xxx-xx", "clustertype" : "", "storageClass" : null, "metadata" : { }, "acl" : null, "bucketStorageClass" : "STANDARD", "bucketType" : "OBJECT", "requestId" : "8abfa7b372160bfd017216560af83e6e" } ] ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.kafka.v2.region.KafkaRegion; import com.huaweicloud.sdk.kafka.v2.*; import com.huaweicloud.sdk.kafka.v2.model.*; public class ListObsBucketsSolution { 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); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("")) .build(); ListObsBucketsRequest request = new ListObsBucketsRequest(); try { ListObsBucketsResponse response = client.listObsBuckets(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] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkafka.v2 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 = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("")) \ .build() try: request = ListObsBucketsRequest() response = client.list_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] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) request := &model.ListObsBucketsRequest{} response, err := client.ListObsBuckets(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Kafka/sdk?api=ListObsBuckets)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询OBS桶列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。