文档

DescribeCustomerGateway - 查询已创建的用户网关

更新时间:

查询已创建的用户网关的详细信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeCustomerGatewayRead
  • CustomerGateway
    acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

请求参数

名称类型必填描述示例值
RegionIdstring

用户网关所属的地域 ID。

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

cn-shanghai
CustomerGatewayIdstring

用户网关的实例 ID。

cgw-bp1pvpl9r9adju6l5****

返回参数

名称类型描述示例值
object

返回结果。

Asnlong

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

65535
RequestIdstring

请求 ID。

A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2
IpAddressstring

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

139.32.XX.XX
Descriptionstring

用户网关的描述信息。

desctest
CustomerGatewayIdstring

用户网关的实例 ID。

cgw-bp1pvpl9r9adju6l5****
CreateTimelong

创建用户网关的时间戳。单位:毫秒。

时间戳的格式采用 Unix 时间戳,表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至创建用户网关时的总时长。

1492747187000
Namestring

用户网关的名称。

nametest
AuthKeystring

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

AuthKey****
Tagsobject []

用户网关绑定的标签列表。

Keystring

标签键。

TagKey
Valuestring

标签值。

TagValue
ResourceGroupIdstring

用户网关所属的资源组 ID。

您可以调用 ListResourceGroups 接口查询资源组信息。

rg-acfmzs372yg****

示例

正常返回示例

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": {
    "Tag": [
      {
        "Key": "TagKey",
        "Value": "TagValue"
      }
    ]
  },
  "ResourceGroupId": "rg-acfmzs372yg****"
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源,请您申请操作权限后再试。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidCustomerGatewayInstanceId.NotFoundThe specified customer gateway instance id does not exist.指定的用户网关实例不存在,请您检查用户网关实例ID是否正确。

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

变更历史

变更时间变更内容概要操作
2023-10-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)