文档

DescribeCustomerGateways - 查询已创建的用户网关列表

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

用户网关所属的地域 ID。

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

cn-shanghai
CustomerGatewayIdstring

用户网关的实例 ID。

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

列表的页码。默认值:1

1
PageSizeinteger

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

10
Tagobject []

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

Keystring

标签键。一旦输入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

一次最多支持输入 20 个标签键。

TagKey
Valuestring

标签值。

标签值最多支持 128 个字符,可以为空字符串,不能以aliyunacs:开头,不能包含http://或者https://

一个标签键对应一个标签值。一次最多支持输入 20 个标签值。

TagValue
ResourceGroupIdstring

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

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

rg-acfmzs372yg****

返回参数

名称类型描述示例值
object

返回结果。

PageSizeinteger

分页查询时每页的条目数。

10
RequestIdstring

请求 ID。

E82612A9-CB90-4D7E-B394-1DB7F6509B29
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
CustomerGatewaysobject []

用户网关信息列表。

IpAddressstring

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

139.32.XX.XX
Asnlong

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

65530
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格式

{
  "PageSize": 10,
  "RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  "PageNumber": 1,
  "TotalCount": 1,
  "CustomerGateways": {
    "CustomerGateway": [
      {
        "IpAddress": "139.32.XX.XX",
        "Asn": 65530,
        "Description": "desctest",
        "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
        "CreateTime": 1492747187000,
        "Name": "nametest",
        "AuthKey": "AuthKey****",
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmzs372yg****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.标签资源重复
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.标签数量超限
400InvalidParameter.TagValueThe specified parameter TagValue is invalid.指定的参数TagValue不合规范。
400InvalidParameter.TagKeyThe specified parameter TagKey is invalid.指定的参数TagKey不合规范。
400Duplicated.TagKeyThe specified parameter TagKey is duplicated.指定的参数TagKey重复。
403Forbbiden.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.您没有权限操作指定资源,请申请权限后再操作。

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

变更历史

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