调用DescribeGateways接口可以查询指定集群ID下的网关列表信息。包括网关ID,网关名称等。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeGateways | 系统规定参数。取值:DescribeGateways。 |
StorageBundleId | String | 是 | sb-0001b2otnkdxrigeq*** | 网关集群ID。 |
PageNumber | Integer | 否 | 1 | 网关列表信息的页码。
|
PageSize | Integer | 否 | 10 | 分页查询时设置的每页行数。
|
返回数据
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeGateways
&StorageBundleId=sb-0001b2otnkdxrigeq***
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeGatewaysResponse>
<TotalCount>2</TotalCount>
<RequestId>2C4A8287-66F4-45F9-84E3-866E4232C763</RequestId>
<Message>successful</Message>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Gateways>
<VpcId>vpc-bp1p0usrgr5z9e7lwr***</VpcId>
<Status>Running</Status>
<Type>File</Type>
<Capacity>500</Capacity>
<GatewayId>gw-0001b2odzvl3b1mhi***</GatewayId>
<IsReleaseAfterExpiration>false</IsReleaseAfterExpiration>
<GatewayType>File</GatewayType>
<BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy</BuyURL>
<EcsInstanceId>gw-0001b2onkdzvl3b***</EcsInstanceId>
<MaxThroughput>30</MaxThroughput>
<GatewayClass>Advanced</GatewayClass>
<InnerIp>172.16.0.21</InnerIp>
<Description>测试使用</Description>
<Name>fio-weekly***</Name>
<InnerIpv6Ip>2408:4004:110:6000:4656:f88e:1c14:e578</InnerIpv6Ip>
<CreatedTime>1577179604</CreatedTime>
<ExpireStatus>0</ExpireStatus>
<DataLoadInterval>120</DataLoadInterval>
<RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew</RenewURL>
<IsPostPaid>true</IsPostPaid>
<PublicNetworkBandwidth>55</PublicNetworkBandwidth>
<StorageBundleId>sb-0001b2otrigeqkso***</StorageBundleId>
<Ip>47.111.145.66</Ip>
<LastErrorKey>InternalError</LastErrorKey>
<ElasticNodes>172.16.0.23</ElasticNodes>
<VSwitchId>vsw-bp1krhkgnahkb9stp0***</VSwitchId>
<CommonBuyInstanceId>gw-0001b2onkdzvl3b***</CommonBuyInstanceId>
<ExpiredTime>1532426471</ExpiredTime>
<GatewayVersion>1.2.6</GatewayVersion>
<DataLoadType>once</DataLoadType>
<ElasticGateway>false</ElasticGateway>
<Category>Aliyun</Category>
<ActivatedTime>1577179769</ActivatedTime>
<TaskId>t-000978oflgrd8ah6p***</TaskId>
<Location>Cloud</Location>
<GatewayRegionId>cn-hangzhou</GatewayRegionId>
<UntrustedEnvInstanceType>ecs.g6.large</UntrustedEnvInstanceType>
<HighAvailability>false</HighAvailability>
<SecondaryVSwitchId>vsw-bp1krhkgnahkb8stp0***</SecondaryVSwitchId>
</Gateways>
<Code>200</Code>
<Success>true</Success>
</DescribeGatewaysResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 2,
"RequestId" : "2C4A8287-66F4-45F9-84E3-866E4232C763",
"Message" : "successful",
"PageSize" : 10,
"PageNumber" : 1,
"Gateways" : [ {
"VpcId" : "vpc-bp1p0usrgr5z9e7lwr***",
"Status" : "Running",
"Type" : "File",
"Capacity" : 500,
"GatewayId" : "gw-0001b2odzvl3b1mhi***",
"IsReleaseAfterExpiration" : false,
"GatewayType" : "File",
"BuyURL" : "https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\"gateway_id\":\"gw-0007va9bnidei3s8a***”,”directBuy\":\"false\",\"gateway_class\":\"standard\",\"cache_cloud_efficiency_size\":0}®ionId=cn-hangzhou#/buy",
"EcsInstanceId" : "gw-0001b2onkdzvl3b***",
"MaxThroughput" : 30,
"GatewayClass" : "Advanced",
"InnerIp" : "172.16.0.21",
"Description" : "测试使用",
"Name" : "fio-weekly***",
"InnerIpv6Ip" : "2408:4004:110:6000:4656:f88e:1c14:e578",
"CreatedTime" : 1577179604,
"ExpireStatus" : 0,
"DataLoadInterval" : 120,
"RenewURL" : "https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew",
"IsPostPaid" : true,
"PublicNetworkBandwidth" : 55,
"StorageBundleId" : "sb-0001b2otrigeqkso***",
"Ip" : "47.111.145.66",
"LastErrorKey" : "InternalError",
"ElasticNodes" : [ "172.16.0.23" ],
"VSwitchId" : "vsw-bp1krhkgnahkb9stp0***",
"CommonBuyInstanceId" : "gw-0001b2onkdzvl3b***",
"ExpiredTime" : 1532426471,
"GatewayVersion" : "1.2.6",
"DataLoadType" : "once",
"ElasticGateway" : false,
"Category" : "Aliyun",
"ActivatedTime" : 1577179769,
"TaskId" : "t-000978oflgrd8ah6p***",
"Location" : "Cloud",
"GatewayRegionId" : "cn-hangzhou",
"UntrustedEnvInstanceType" : "ecs.g6.large",
"HighAvailability" : false,
"SecondaryVSwitchId" : "vsw-bp1krhkgnahkb8stp0***"
} ],
"Code" : "200",
"Success" : true
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
HttpCode |
错误码 |
错误信息 |
描述 |
400 | EmptyStorageBundleId | You must enter a valid ID for the gateway cluster. | 网关集群ID不能为空。 |
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。 |
404 | StorageBundleNotExist | The name you specified for the gateway cluster does not exist. You must specify a valid parameter. | 网关集群不存在,请确认输入参数是否正确。 |
访问错误中心查看更多错误码。
上一篇:无下一篇:云存储网关
该文章对您有帮助吗?
- 本页导读 (1)
- 请求参数
- 返回数据
- 示例
- 错误码