备案控制台
文档
产品文档
输入文档关键字查找
首页 云连接器 开发参考 API参考 API目录 授权规则 ListAuthorizationRules - 查询授权规则

ListAuthorizationRules - 查询授权规则

更新时间：
一键部署
提交缺陷
产品详情
我的收藏

查询授权规则信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
IoTCloudConnectorIdstring是

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
AuthorizationRuleIdsarray否

授权规则 ID 列表。最多支持传入 20 个授权规则 ID。

string否

授权规则 ID 列表。最多支持传入 20 个授权规则 ID。

ar-1234abcb8tmno0hdq****
DestinationTypearray否

访问目标类型。最多支持传入 20 个访问目标类型。取值：

  • Cidr：CIDR 地址块。
  • Domain：域名。
string否

访问目标类型。最多支持传入 20 个访问目标类型。取值：

  • Cidr：CIDR 地址块。
  • Domain：域名。
Cidr
Protocolarray否

协议类型。最多支持输入 20 个协议类型。取值：

  • tcp。
  • udp。
  • icmp。
  • all：支持所有协议。
string否

协议类型。最多支持输入 20 个协议类型。取值：

  • tcp。
  • udp。
  • icmp。
  • all：支持所有协议。
tcp
DestinationPortarray否

目标端口范围。最多支持 20 个端口取值范围。取值范围：

  • TCP、UDP 协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。
  • ICMP 协议：-1/-1。
  • ALL：-1/-1。
string否

目标端口范围。最多支持 20 个端口取值范围。取值范围：

  • TCP、UDP 协议：1~65535。使用正斜线（/）隔开起始端口和终止端口。例如：1/200。
  • ICMP 协议：-1/-1。
  • ALL：-1/-1。
80/80
Destinationarray否

访问目标。

string否

访问目标。最多支持 20 个访问目标。

192.168.XX.XX
AuthorizationRuleStatusarray否

授权规则状态。最多支持传入 20 个授权规则状态。取值：

  • Creating：创建中。
  • Created：创建完成。
  • Deleting：删除中。
  • Updating：更新中。
string否

授权规则状态。最多支持传入 20 个授权规则状态。取值：

  • Creating：创建中。
  • Created：创建完成。
  • Deleting：删除中。
  • Updating：更新中。
Created
AuthorizationRuleNamearray否

授权规则名称。最多支持传入 20 个授权规则名称。

名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。

string否

授权规则名称。最多支持传入 20 个授权规则名称。

名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。

rule01
Policyarray否

访问策略。最多支持传入 20 个访问策略。

  • Permit：允许。
  • Deny：拒绝。
string否

访问策略。最多支持传入 20 个访问策略。取值：

  • Permit：允许。
  • Deny：拒绝。
Permit
NextTokenstring否

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。
caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger否

分页大小，取值：1~50。传入为空时，默认值：10。

10
RegionIdstring是

云连接器实例所在的地域 ID。

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

cn-hangzhou
AuthorizationRuleTypestring否

授权规则的类型。取值：

  • System，表示授权规则的类型为系统类型。

  • Customer：表示授权规则的类型为自定义类型。

  • Default：表示授权规则的类型为默认类型。

System
FuzzyDestinationstring否

模糊的访问目标

aliyuncs
FuzzyAuthorizationRuleNamestring否

模糊的授权规则名称

测试

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCountinteger

授权规则总数。

10
NextTokenstring

是否拥有下一次查询的令牌（Token）。取值：

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。
caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

分页大小。

10
AuthorizationRulesobject []

授权规则列表。

IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
Policystring

访问策略。取值：

  • Permit：允许。
  • Deny：拒绝。
Permit
AuthorizationRuleStatusstring

授权规则状态。取值：

  • Creating：创建中。
  • Created：创建完成。
  • Deleting：删除中。
  • Updating：更新中。
Created
SourceCidrsarray

源 CIDR 地址块。

string

源 CIDR 地址块。

192.168.XX.XX
DestinationTypestring

访问目标类型。取值：

  • Cidr：CIDR 地址块。
  • Domain：域名。
Cidr
Protocolstring

协议类型。取值：

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

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

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

访问目标。

192.168.XX.XX
AuthorizationRuleNamestring

授权规则名称。

名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。

rule01
AuthorizationRuleDescriptionstring

授权规则描述。

rule01
AuthorizationRuleIdstring

授权规则 ID。

ar-1234abcb8tmno0hdq****
AuthorizationRuleTypestring

授权规则的类型。取值：

  • System，表示授权规则的类型为系统类型。

  • Customer：表示授权规则的类型为自定义类型。

  • Default：表示授权规则的类型为默认类型。

System

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 10,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 10,
  "AuthorizationRules": [
    {
      "IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
      "Policy": "Permit",
      "AuthorizationRuleStatus": "Created",
      "SourceCidrs": [
        "192.168.XX.XX"
      ],
      "DestinationType": "Cidr",
      "Protocol": "tcp",
      "DestinationPort": "80/80",
      "Destination": "192.168.XX.XX",
      "AuthorizationRuleName": "rule01",
      "AuthorizationRuleDescription": "rule01",
      "AuthorizationRuleId": "ar-1234abcb8tmno0hdq****",
      "AuthorizationRuleType": "System"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400ResourceNotFound.IoTCloudConnectorThe param of IoTCloudConnectorId is illegal.IoTCloudConnectorId参数非法

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

变更历史

变更时间变更内容概要操作
2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
入参OpenAPI 入参发生变更。
    新增入参：FuzzyDestination
    新增入参：FuzzyAuthorizationRuleName
2021-11-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
  • 本页导读 （1）
文档反馈