DescribeStorageBundles - 查询集群列表信息

查询集群列表信息。包括网关集群名称、描述及创建时间等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeStorageBundles

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

BackendBucketRegionId

string

网关集群所在的地域。可以通过 DescribeRegions 接口获得有效的 regionId。

cn-hangzhou

PageNumber

integer

网关集群列表信息的页码。

起始值:1。

默认值:1。

1

PageSize

integer

分页查询时设置的每页行数。

最大值:50。

默认值:10。

10

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

网关集群的总数。

20

RequestId

string

请求 ID。

1EB4639B-0812-4F2D-AB78-194E67645E357

Message

string

请求结果描述。

successful

PageSize

integer

分页展示返回的网关集群列表时的每页行数。

10

PageNumber

integer

网关集群列表的页码。

1

Code

string

状态码。状态码为 200 表示请求成功。

200

Success

boolean

请求是否成功。

true

StorageBundles

object

StorageBundle

array<object>

网关集群信息。

object

Description

string

网关集群的描述。

测试使用

BackendBucketRegionId

string

网关集群所在的地域。

cn-hangzhou

StorageBundleId

string

网关集群 ID。

sb-000ibk4xrlr03qrjr***

Name

string

网关集群名称。

zy-test***

CreatedTime

integer

网关集群创建时间。时间戳为秒(s)。

1565750633

示例

正常返回示例

JSON格式

{
  "TotalCount": 20,
  "RequestId": "1EB4639B-0812-4F2D-AB78-194E67645E357",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Code": "200",
  "Success": true,
  "StorageBundles": {
    "StorageBundle": [
      {
        "Description": "测试使用",
        "BackendBucketRegionId": "cn-hangzhou",
        "StorageBundleId": "sb-000ibk4xrlr03qrjr***",
        "Name": "zy-test***",
        "CreatedTime": 1565750633
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 BadPageSize The specified number of pages is invalid. The number ranges from 1 to 50. 无效的页数,取值范围:1~50。
400 BadPageNumber The specified page number is invalid. The page number must be greater than 0. 无效的页码,不能小于0。
400 InvalidRegionId The specified RegionId does not exist. You must specify a valid RegionId. 指定的RegionId不存在,请您确认该参数是否正确。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情