调用DescribeStorageBundles可以查询指定地域对应的集群列表信息。包括网关集群名称、描述及创建时间等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeStorageBundles |
系统规定参数。取值:DescribeStorageBundles。 |
BackendBucketRegionId | String | 是 | cn-hangzhou |
网关集群所在的地域。可以通过DescribeRegions接口获得有效的regionId。 |
PageNumber | Integer | 否 | 1 |
网关集群列表信息的页码。 起始值:1。 默认值:1。 |
PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。 最大值:50。 默认值:10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 1EB4639B-0812-4F2D-AB78-194E67645E357 |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
Code | String | 200 |
状态码。状态码为200表示请求成功。 |
Message | String | successful |
请求结果描述。 |
TotalCount | Integer | 20 |
网关集群的总数。 |
PageNumber | Integer | 1 |
网关集群列表的页码。 |
PageSize | Integer | 10 |
分页展示返回的网关集群列表时的每页行数。 |
StorageBundles | Array |
网关集群信息。 |
|
StorageBundleId | String | sb-000ibk4xrlr03qrjr*** |
网关集群ID。 |
Name | String | zy-test*** |
网关集群名称。 |
Description | String | 测试使用 |
网关集群的描述。 |
BackendBucketRegionId | String | cn-hangzhou |
网关集群所在的地域。 |
CreatedTime | Long | 1565750633 |
网关集群创建时间。时间戳为秒(s)。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeStorageBundles
&BackendBucketRegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<DescribeStorageBundlesResponse>
<TotalCount>3</TotalCount>
<Message>successful</Message>
<PageSize>5</PageSize>
<RequestId>0F96A15D-BA06-4A34-9587-AA8C9C230E80</RequestId>
<PageNumber>1</PageNumber>
<Code>200</Code>
<StorageBundles>
<StorageBundle>
<CreatedTime>1568795768</CreatedTime>
<StorageBundleId>sb-0007y2889yyxkuqov***</StorageBundleId>
<BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>
<Description>测试使用</Description>
<Name>sgw1-test***</Name>
</StorageBundle>
<StorageBundle>
<CreatedTime>1533283347</CreatedTime>
<StorageBundleId>sb-000dai44c82bp6i32***</StorageBundleId>
<BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>
<Description>测试使用</Description>
<Name>sgw2-test***</Name>
</StorageBundle>
<StorageBundle>
<CreatedTime>1532663546</CreatedTime>
<StorageBundleId>sb-000e9qyjn694q148r***</StorageBundleId>
<BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>
<Description>测试使用</Description>
<Name>sgw3-test***</Name>
</StorageBundle>
</StorageBundles>
<Success>true</Success>
</DescribeStorageBundlesResponse>
JSON
格式
{
"TotalCount":3,
"Message":"successful",
"PageSize":5,
"RequestId":"0F96A15D-BA06-4A34-9587-AA8C9C230E80",
"PageNumber":1,
"Code":"200",
"StorageBundles":{
"StorageBundle":[
{
"CreatedTime":1568795768,
"StorageBundleId":"sb-0007y2889yyxkuqov***",
"BackendBucketRegionId":"cn-shanghai",
"Description":"测试使用",
"Name":"sgw1-test***"
},
{
"CreatedTime":1533283347,
"StorageBundleId":"sb-000dai44c82bp6i32***",
"BackendBucketRegionId":"cn-shanghai",
"Description":"测试使用",
"Name":"sgw2-test***"
},
{
"CreatedTime":1532663546,
"StorageBundleId":"sb-000e9qyjn694q148r***",
"BackendBucketRegionId":"cn-shanghai",
"Description":"测试使用",
"Name":"sgw3-test***"
}
]
},
"Success":true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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不存在,请您确认该参数是否正确。 |
访问错误中心查看更多错误码。