DescribeResolverEndpoints - 获取终端节点列表

调用DescribeResolverEndpoints获取终端节点列表。

调试

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

授权信息

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

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

请求参数

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

终端节点名称关键字,使用模糊搜索的方式查询。

终端节点-test
Langstring

返回值语言,取值:

  • zh:中文。

  • en:英文。

默认值:en

en
PageNumberinteger

分页查询时设置查询的页码,起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页数据量,最大值 100,默认为 20。

20
Statusstring

终端节点状态。取值:

  • SUCCESS: 工作正常。
  • INIT:创建中。
  • FAILED:创建失败。
  • CHANGE_INIT: 修改中。
  • CHANGE_FAILED: 修改失败。
  • EXCEPTION: 工作异常。
说明 不传获取全部,传入则获取指定状态。
SUCCESS
VpcRegionIdstring

出站 VPC 所在地域 ID。

cn-zhangjiakou

返回参数

名称类型描述示例值
object
Endpointsarray<object>

终端节点列表。

Endpointobject

节点信息。

Statusstring

终端节点状态。描述:

  • SUCCESS: 工作正常。
  • INIT:创建中。
  • FAILED:创建失败。
  • CHANGE_INIT: 修改中。
  • CHANGE_FAILED: 修改失败。
  • EXCEPTION: 工作异常。
SUCCESS
VpcIdstring

出站专有网络 ID(VPC ID),解析器所有出站的 DNS 查询流量都将经由此 VPC 进行流量转发。

vpc-0jlxhpfnj5bfu0bsd****
UpdateTimestring

更新时间。

2020-07-13 10:38:24
SecurityGroupIdstring

安全组 ID。

sg-0jld3m9yq7l2cw12****
CreateTimestring

创建时间。

2020-07-13 10:36:26
VpcRegionIdstring

出站 VPC 所在地域 ID。

cn-zhangjiakou
IpConfigsarray<object>

出站流量源 IP 列表。

IpConfigobject

出站流量源 IP 信息。

VSwitchIdstring

交换机 ID。

vsw-0jlgeyq4oazkh5xue****
CidrBlockstring

子网掩码,交换机的 IPv4 网段。

172.16.XX.XX/24
Ipstring

子网掩码参数范围内的 IP 地址。

172.16.XX.XX
AzIdstring

交换机所属的可用区 ID。

cn-zhangjiakou-a
VpcNamestring

出站 VPC 名称。

vpc-test-name
UpdateTimestamplong

更新时间(时间戳)。

1594607904000
VpcRegionNamestring

出站 VPC 所在地域名称。

杭州VPC测试
Namestring

终端节点名称。

终端节点-test
Idstring

终端节点 ID。

hr****
CreateTimestamplong

创建时间(时间戳)。

1594607786000
PageSizeinteger

每页返回的数据量。

2
RequestIdstring

唯一请求识别码。

83D1682B-B69A-4060-9FA8-2907C2A35600
PageNumberinteger

返回数据的当前页码。

1
TotalPagesinteger

数据的总页数。

1
TotalItemsinteger

终端节点总个数。

1

示例

正常返回示例

JSON格式

{
  "Endpoints": [
    {
      "Status": "SUCCESS",
      "VpcId": "vpc-0jlxhpfnj5bfu0bsd****",
      "UpdateTime": "2020-07-13 10:38:24",
      "SecurityGroupId": "sg-0jld3m9yq7l2cw12****",
      "CreateTime": "2020-07-13 10:36:26",
      "VpcRegionId": "cn-zhangjiakou",
      "IpConfigs": [
        {
          "VSwitchId": "vsw-0jlgeyq4oazkh5xue****",
          "CidrBlock": "172.16.XX.XX/24",
          "Ip": "172.16.XX.XX",
          "AzId": "cn-zhangjiakou-a"
        }
      ],
      "VpcName": "vpc-test-name",
      "UpdateTimestamp": 1594607904000,
      "VpcRegionName": "杭州VPC测试",
      "Name": "终端节点-test",
      "Id": "hr****",
      "CreateTimestamp": 1594607786000
    }
  ],
  "PageSize": 2,
  "RequestId": "83D1682B-B69A-4060-9FA8-2907C2A35600",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-09OpenAPI 入参发生变更查看变更详情