文档

ListAuthorizationRules - 查询授权规则

更新时间:
一键部署

查询授权规则列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

5G 高速上云实例 id。

cc5g-xxxx
Statusesarray

授权规则状态列表

string

授权规则状态,取值:

  • Creating:创建中
  • Pending:配置中
  • Available:有效的稳定状态
  • Invalid: 无效
  • Deleting:删除中
Creating
AuthorizationRuleIdsarray

授权规则 id 列表。

string

授权规则 id

ar5g-xxxx
Namesarray

授权规则名称列表

string

名称,长度不超过 128 字符。

Test
DestinationTypestring

目标类型,取值:

  • Cidr: 网段
  • Domain: 域名或泛域名
  • IpPort: IP 重定向
Cidr
Protocolstring

协议类型。取值:

  • tcp
  • udp
  • icmp
  • all:支持所有协议。
all
DestinationPortstring

目标端口范围。取值范围:

  • TCP、UDP 协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。

  • ICMP 协议:-1/-1。

  • ALL:-1/-1。

-1/-1
Destinationstring

目标地址、域名或泛域名,前缀匹配。

10.0.0.1
Policystring

授权规则策略,取值:

  • Permit:允许
  • Deny:拒绝
  • Mapping:重定向
Permit
Typestring

类型,取值:

  • System: 系统
  • Default: 默认
  • Customer: 自定义
System
Dnsboolean

是否为 DNS。

true
NextTokenstring

上一页的查询返回的值,首页查询不传值。

iou001238joojjaere
MaxResultslong

分页查询时每页的行数,最大值为 50,默认值为 10

10

返回参数

名称类型描述示例值
object

响应对象

RequestIdstring

请求 id。

207F9929-806E-5622-8E4F-8484F7000C22
AuthorizationRulesobject []

授权规则列表。

AuthorizationRuleIdstring

授权规则 id。

ar5g-xxxx
Statusstring

授权规则状态,取值:

  • Creating: 创建中
  • Pending: 配置中
  • Available: 有效的稳定状态
  • Invalid: 无效
  • Deleting: 删除中
Pending
Namestring

授权规则名称。

test
Descriptionstring

授权规则描述。

ar5g-test
Typestring

类型,取值:

  • System: 系统
  • Default: 默认
  • Customer: 自定义
Default
SourceCidrstring

源 CIDR 地址块。

0.0.0.0/0
DestinationTypestring

目标类型,取值:

  • Cidr: 网段
  • Domain: 域名或泛域名
  • IpPort: IP 重定向
Cidr
Protocolstring

协议类型。取值:

  • tcp
  • udp
  • icmp
  • all:支持所有协议。
all
DestinationPortstring

目标端口范围。取值范围:

  • TCP、UDP 协议:1~65535。使用正斜线(/)隔开起始端口和终止端口。例如:1/200。
  • ICMP 协议:-1/-1。
  • ALL:-1/-1。
0-65535
Destinationstring

目标地址、域名或泛域名,前缀匹配。

10.0.0.0/24
Policystring

授权规则策略,取值:

  • Permit:允许
  • Deny:拒绝
  • Mapping:重定向
Permit
Dnsboolean

是否为 DNS。

true
CreateTimestring

创建时间。

2022-3-15 22:20:00
NextTokenstring

下一次查询的起始 token。

iou001238joojjaere
MaxResultsstring

分页查询时每页的行数,最大值为 50,默认值为 10

10
TotalCountstring

列表的条目数。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "207F9929-806E-5622-8E4F-8484F7000C22",
  "AuthorizationRules": [
    {
      "AuthorizationRuleId": "ar5g-xxxx",
      "Status": "Pending",
      "Name": "test",
      "Description": "ar5g-test",
      "Type": "Default",
      "SourceCidr": "0.0.0.0/0",
      "DestinationType": "Cidr",
      "Protocol": "all",
      "DestinationPort": "0-65535",
      "Destination": "10.0.0.0/24",
      "Policy": "Permit",
      "Dns": true,
      "CreateTime": "2022-3-15 22:20:00"
    }
  ],
  "NextToken": "iou001238joojjaere",
  "MaxResults": "10",
  "TotalCount": "2"
}

错误码

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

  • 本页导读 (0)
文档反馈