DescribeResolverRules - 获取转发规则列表

获取转发规则列表。

调试

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

授权信息

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

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

请求参数

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

”转发规则名称“关键字。支持模糊查询,不区分大小写。

test
Langstring

返回值语言,取值:

  • zh:中文。

  • en:英文。

默认值:en

en
PageNumberinteger

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

1
PageSizeinteger

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

20
NeedDetailAttributesboolean

是否需要额外信息(转发规则关联的 VPC 列表)。取值:

  • true:需要。
  • false:不需要。

默认值:false。

true
EndpointIdstring

出站终端节点 ID。

hr****

返回参数

名称类型描述示例值
object
PageSizeinteger

返回的每页数据量。

10
RequestIdstring

唯一请求识别码。

A10E03D7-808C-422D-9144-F8586C2E2297
PageNumberinteger

返回数据的当前页码。

1
TotalPagesinteger

全部数据的总页数。

1
TotalItemsinteger

总个数。

1
Rulesarray<object>

转发规则列表。

Ruleobject

转发规则信息。

Typestring

转发规则类型(目前仅支持选择转发至外部 IP)。取值:

OUTBOUND: 转发至外部 IP。

OUTBOUND
UpdateTimestring

更新时间

2020-07-13 10:51:44
ForwardIpsarray<object>

外部 DNS 系统 IP 地址和端口。DNS 查询流量被转发的目标服务器的 IP 地址和端口。

ForwardIpobject

目标服务器的 IP 地址和端口。

Ipstring

转发目标 IP 地址。

172.16.XX.XX
Portinteger

转发目标 IP 地址的端口号。

80
EndpointNamestring

终端节点名称。

终端节点-test
CreateTimestring

创建时间

2020-07-13 10:51:44
ZoneNamestring

需要转发解析请求的域名(Zone)。

example.com
UpdateTimestamplong

更新时间(时间戳)。

1594608704000
BindVpcsarray<object>

关联的 VPC 列表。

Vpcobject

VPC 信息。

VpcNamestring

专有网络名称(VPC Name)。

vpc-name-test
VpcIdstring

专有网络 ID(VPC ID),VPC 唯一识别码。

vpc-0jl96awrjt75ezglc****
VpcTypestring

VPC 类型。取值:

  • STANDARD:标准 VPC。

  • EDS:无影工作区 VPC。

STANDARD
RegionNamestring

VPC 所属地域名称。

China (Ulanqab)
RegionIdstring

VPC 所属地域 ID。

cn-wulanchabu
VpcUserIdstring

VPC 实际归属账号 UID。

141339776561****
EndpointIdstring

终端节点 ID。

hr****
Namestring

转发规则名称。

转发规则-test
Idstring

转发规则 Id。

hr****
CreateTimestamplong

创建时间(时间戳)。

1594608704000

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "A10E03D7-808C-422D-9144-F8586C2E2297",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1,
  "Rules": [
    {
      "Type": "OUTBOUND",
      "UpdateTime": "2020-07-13 10:51:44",
      "ForwardIps": [
        {
          "Ip": "172.16.XX.XX",
          "Port": 80
        }
      ],
      "EndpointName": "终端节点-test",
      "CreateTime": "2020-07-13 10:51:44",
      "ZoneName": "example.com",
      "UpdateTimestamp": 1594608704000,
      "BindVpcs": [
        {
          "VpcName": "vpc-name-test",
          "VpcId": "vpc-0jl96awrjt75ezglc****",
          "VpcType": "STANDARD",
          "RegionName": "China (Ulanqab)",
          "RegionId": "cn-wulanchabu",
          "VpcUserId": "141339776561****"
        }
      ],
      "EndpointId": "hr****",
      "Name": "转发规则-test",
      "Id": "hr****",
      "CreateTimestamp": 1594608704000
    }
  ]
}

错误码

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