文档

DescribeResolverRules - 获取转发规则列表

更新时间:

获取转发规则列表。

调试

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

授权信息

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

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

请求参数

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

关键字,照”%Keyword%”模式搜索规则名称

test
Langstring

语言

en
PageNumberinteger

当前页码, 默认值 1

1
PageSizeinteger

页面大小,默认值 20;最大支持 100

20
NeedDetailAttributesboolean

是否需要额外信息,默认为 false;

  • true-需要额外信息,含转发规则关联的 VPC 列表等
  • false-不需要额外信息
true
EndpointIdstring

出站终端节点 ID

hra2**

返回参数

名称类型描述示例值
object
PageSizeinteger

页面大小

10
RequestIdstring

唯一请求识别码

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

页码

1
TotalPagesinteger

总页数

1
TotalItemsinteger

总个数

1
Rulesobject []

转发规则列表

Typestring

转发类型。

  • OUTBOUD:转发至外部 IP
OUTBOUND
UpdateTimestring

更新时间

2020-07-13 10:51:44
ForwardIpsobject []

转发目标 IP 地址列表

Ipstring

IP 地址

172.16.xx.xx
Portinteger

端口号

8080
EndpointNamestring

终端节点名称

终端节点-test
CreateTimestring

创建时间

2020-07-13 10:51:44
ZoneNamestring

转发 zone 名称

example.com
UpdateTimestamplong

更新时间戳

1594608704000
BindVpcsobject []

关联的 VPC 列表

VpcNamestring

VPC 名称

vpc-name-test
VpcIdstring

VPC ID

vpc-8vbl8mpum-vpc-id
VpcTypestring

VPC 类型

● STANDARD(标准VPC) ● EDS(无影工作区VPC)
RegionNamestring

地域名称

杭州测试
RegionIdstring

地域 ID

cn-hangzhou
VpcUserIdstring

VPC 实际归属账号 UID,

121098702443**
EndpointIdstring

终端节点 ID

hra0**
Namestring

转发规则名称

转发规则-test
Idstring

转发规则 Id

hra1**
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": 8080
        }
      ],
      "EndpointName": "终端节点-test",
      "CreateTime": "2020-07-13 10:51:44",
      "ZoneName": "example.com",
      "UpdateTimestamp": 1594608704000,
      "BindVpcs": [
        {
          "VpcName": "vpc-name-test",
          "VpcId": "vpc-8vbl8mpum-vpc-id",
          "VpcType": "● STANDARD(标准VPC)\n● EDS(无影工作区VPC)",
          "RegionName": "杭州测试",
          "RegionId": "cn-hangzhou",
          "VpcUserId": "121098702443**"
        }
      ],
      "EndpointId": "hra0**",
      "Name": "转发规则-test",
      "Id": "hra1**",
      "CreateTimestamp": 1594608704000
    }
  ]
}

错误码

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

  • 本页导读