Queries the information of the gateway clusters in a specified region. The information of a gateway cluster includes the name, description, and the time at which the gateway cluster is created.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeStorageBundles |
The operation that you want to perform. Set the value to DescribeStorageBundles. |
BackendBucketRegionId | String | Yes | cn-hangzhou |
The region where the gateway clusters reside. You can query the region ID by calling the DescribeRegions operation. |
PageNumber | Integer | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Maximum value: 50. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 1EB4639B-0812-4F2D-AB78-194E67645E357 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
Code | String | 200 |
The HTTP status code. If the request is successful, 200 is returned. |
Message | String | successful |
The description of the status code. |
TotalCount | Integer | 20 |
The total number of gateway clusters. |
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 10 |
The number of entries returned per page. |
StorageBundles | Array |
The list of gateway clusters. |
|
StorageBundleId | String | sb-000ibk4xrlr03qrjr*** |
The ID of the gateway cluster. |
Name | String | zy-test*** |
The name of the gateway cluster. |
Description | String | Test |
The description of the gateway cluster. |
BackendBucketRegionId | String | cn-hangzhou |
The region where the gateway clusters reside. |
CreatedTime | Long | 1565750633 |
The time at which the gateway cluster was created. The timestamp. Unit: seconds. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeStorageBundles
&BackendBucketRegionId=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
<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>Test</Description>
<Name>sgw1-test***</Name>
</StorageBundle>
<StorageBundle>
<CreatedTime>1533283347</CreatedTime>
<StorageBundleId>sb-000dai44c82bp6i32***</StorageBundleId>
<BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>
<Description>Test</Description>
<Name>sgw2-test***</Name>
</StorageBundle>
<StorageBundle>
<CreatedTime>1532663546</CreatedTime>
<StorageBundleId>sb-000e9qyjn694q148r***</StorageBundleId>
<BackendBucketRegionId>cn-shanghai</BackendBucketRegionId>
<Description>Test</Description>
<Name>sgw3-test***</Name>
</StorageBundle>
</StorageBundles>
<Success>true</Success>
</DescribeStorageBundlesResponse>
JSON
format
{
"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": "Test",
"Name":"sgw1-test***"
},
{
"CreatedTime":1533283347,
"StorageBundleId":"sb-000dai44c82bp6i32***",
"BackendBucketRegionId":"cn-shanghai",
"Description": "Test",
"Name":"sgw2-test***"
},
{
"CreatedTime":1532663546,
"StorageBundleId":"sb-000e9qyjn694q148r***",
"BackendBucketRegionId":"cn-shanghai",
"Description": "Test",
"Name":"sgw3-test***"
}
]
},
"Success":true
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | BadPageSize | The specified number of pages is invalid. The number ranges from 1 to 50. | The error message returned because the page number is invalid. Valid values: 1 to 50. |
400 | BadPageNumber | The specified page number is invalid. The page number must be greater than 0. | The error message returned because the page number cannot be less than 0. |
400 | InvalidRegionId | The specified RegionId does not exist. You must specify a valid RegionId. | The error message returned because the specified RegionId parameter does not exist. Check whether the parameter is valid. |
For a list of error codes, visit the API Error Center.