调用DescribeCustomerGateways接口查询用户网关的信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCustomerGateways

系统规定参数。取值:DescribeCustomerGateways

RegionId String cn-shanghai

用户网关所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

CustomerGatewayId String cgw-bp1pvpl9r9adju6l5****

用户网关的实例ID。

说明 如果您不指定用户网关的实例ID,则系统默认查询当前地域下所有用户网关的信息。
PageNumber Integer 1

列表的页码。默认值:1

PageSize Integer 10

分页查询时每页的行数。最大值:50。默认值:10

返回数据

名称 类型 示例值 描述
PageSize Integer 10

分页查询时每页的行数。

RequestId String E82612A9-CB90-4D7E-B394-1DB7F6509B29

请求ID。

PageNumber Integer 1

列表的页码。

TotalCount Integer 1

列表条目数。

CustomerGateways Array of CustomerGateway

用户网关信息列表。

CustomerGateway
IpAddress String 139.32.XX.XX

本地数据中心网关设备的公网IP地址。

Asn Long 65530

本地数据中心网关设备的自治系统号。

Description String desctest

用户网关的描述信息。

CustomerGatewayId String cgw-bp1pvpl9r9adju6l5****

用户网关的实例ID。

CreateTime Long 1492747187000

创建用户网关的时间戳。

Name String nametest

用户网关的名称。

AuthKey String AuthKey****

本地数据中心网关设备BGP路由协议的认证密钥。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCustomerGateways
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCustomerGatewaysResponse>
    <PageSize>10</PageSize>
    <RequestId>E82612A9-CB90-4D7E-B394-1DB7F6509B29</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <CustomerGateways>
        <IpAddress>139.32.XX.XX</IpAddress>
        <Asn>65530</Asn>
        <Description>desctest</Description>
        <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5****</CustomerGatewayId>
        <CreateTime>1492747187000</CreateTime>
        <Name>nametest</Name>
        <AuthKey>AuthKey****</AuthKey>
    </CustomerGateways>
</DescribeCustomerGatewaysResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "CustomerGateways" : [ {
    "IpAddress" : "139.32.XX.XX",
    "Asn" : 65530,
    "Description" : "desctest",
    "CustomerGatewayId" : "cgw-bp1pvpl9r9adju6l5****",
    "CreateTime" : 1492747187000,
    "Name" : "nametest",
    "AuthKey" : "AuthKey****"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. 您没有权限操作该资源,请您申请操作权限后再试。
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源,请申请权限后再操作。

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