调用DescribeCustomerGateway接口查询指定的用户网关的信息

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCustomerGateway	系统规定参数。取值：DescribeCustomerGateway。
RegionId	String	是	cn-shanghai	用户网关所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。
CustomerGatewayId	String	是	cgw-bp1pvpl9r9adju6l5****	用户网关的实例ID。

返回数据


名称	类型	示例值	描述
Asn	Long	65535	本地数据中心网关设备的自治系统号。
RequestId	String	A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2	请求ID。
IpAddress	String	139.32.XX.XX	本地数据中心网关设备的公网IP地址。
Description	String	desctest	用户网关的描述信息。
CustomerGatewayId	String	cgw-bp1pvpl9r9adju6l5****	用户网关的实例ID。
CreateTime	Long	1492747187000	创建用户网关的时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至创建用户网关时的总时长。
Name	String	nametest	用户网关的名称。
AuthKey	String	AuthKey****	本地数据中心网关设备BGP路由协议的认证密钥。
Tags	Array of Tag		用户网关绑定的标签列表。
Tag
Key	String	TagKey	标签键。
Value	String	TagValue	标签值。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCustomerGateway
&RegionId=cn-shanghai
&CustomerGatewayId=cgw-bp1pvpl9r9adju6l5****
&公共请求参数

正常返回示例

XML格式

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

<DescribeCustomerGatewayResponse>
    <Asn>65535</Asn>
    <RequestId>A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2</RequestId>
    <IpAddress>139.32.XX.XX</IpAddress>
    <Description>desctest</Description>
    <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5****</CustomerGatewayId>
    <CreateTime>1492747187000</CreateTime>
    <Name>nametest</Name>
    <AuthKey>AuthKey****</AuthKey>
    <Tags>
        <Key>TagKey</Key>
        <Value>TagValue</Value>
    </Tags>
</DescribeCustomerGatewayResponse>

JSON格式

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

{
  "Asn" : 65535,
  "RequestId" : "A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2",
  "IpAddress" : "139.32.XX.XX",
  "Description" : "desctest",
  "CustomerGatewayId" : "cgw-bp1pvpl9r9adju6l5****",
  "CreateTime" : 1492747187000,
  "Name" : "nametest",
  "AuthKey" : "AuthKey****",
  "Tags" : [ {
    "Key" : "TagKey",
    "Value" : "TagValue"
  } ]
}

错误码


HttpCode	错误码	错误信息	描述
403	Forbidden.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.	您没有权限操作指定资源，请申请权限后再操作。
404	InvalidCustomerGatewayInstanceId.NotFound	The specified customer gateway instance id does not exist.	指定的用户网关实例不存在，请您检查用户网关实例ID是否正确。

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