文档

ListGroupAuthorizationRules - 查询实例组的授权规则

更新时间:

查询实例组的授权规则信息。

调试

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

调试

授权信息

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

请求参数

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

实例组ID。

iotccg-g00epppbi9di9y****
AuthorizationRuleIdsarray

授权规则ID。最多支持20个授权规则ID。

string

授权规则ID。最多支持20个授权规则ID。

gar-ez91t41jvi6tr8****
DestinationTypearray

访问目标类型。最多支持20个目标类型。取值:

  • Cidr:CIDR地址块。
  • Domain:域名。
string

访问目标类型。最多支持20个目标类型。取值:

  • Cidr:CIDR地址块。
  • Domain:域名。
Cidr
Destinationarray

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

string

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

47.0.XX.XX
Protocolarray

协议类型。取值:

  • 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
AuthorizationRuleStatusarray

授权规则状态。最多支持20个授权规则状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

string

授权规则状态。最多支持20个授权规则状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

Created
AuthorizationRuleNamearray

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

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

string

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

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

ruletest
Policyarray

访问策略。最多支持20个访问策略。取值:

  • Permit:允许。

  • Deny:拒绝。

string

访问策略。最多支持20个访问策略。取值:

  • Permit:允许。

  • Deny:拒绝。

Permit
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

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

分批次查询时每次显示的条目数。取值:1~50。默认值:10

10
RegionIdstring

实例组所在的地域ID。

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

cn-hangzhou
Typestring

授权规则的类型。取值:

  • System,表示授权规则的类型为系统类型。
  • Customer:表示授权规则的类型为自定义类型。
  • Default:表示授权规则的类型为默认类型。
System

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
TotalCountinteger

总列表条目数。

10
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

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

分批次查询时每次显示的条目数。

10
GroupAuthorizationRulesarray

授权规则列表。

object

授权规则列表。

IoTCloudConnectorGroupIdstring

实例组ID。

iotccg-g00epppbi9di9y****
Policystring

访问策略。取值:

  • Permit:允许。

  • Deny:拒绝。

Permit
AuthorizationRuleStatusstring

授权规则状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

Created
SourceCidrsarray

源CIDR地址块。

string

源CIDR地址块。

192.168.0.0/32
DestinationTypestring

访问目标类型。取值:

  • Cidr:CIDR地址块。
  • Domain:域名。
Cidr
DestinationPortstring

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

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

协议类型。取值:

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

访问目标地址。

47.0.XX.XX
AuthorizationRuleNamestring

授权规则的名称。

ruletest
AuthorizationRuleDescriptionstring

授权规则的描述信息。

rule
AuthorizationRuleIdstring

授权规则ID。

gar-ez91t41jvi6tr8****
Typestring

授权规则的类型。取值:

  • System,表示授权规则的类型为系统类型。
  • Customer:表示授权规则的类型为自定义类型。
  • Default:表示授权规则的类型为默认类型。
System

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 10,
  "GroupAuthorizationRules": [
    {
      "IoTCloudConnectorGroupId": "iotccg-g00epppbi9di9y****",
      "Policy": "Permit",
      "AuthorizationRuleStatus": "Created",
      "SourceCidrs": [
        "192.168.0.0/32"
      ],
      "DestinationType": "Cidr",
      "DestinationPort": "80/80",
      "Protocol": "tcp",
      "Destination": "47.0.XX.XX",
      "AuthorizationRuleName": "ruletest",
      "AuthorizationRuleDescription": "rule",
      "AuthorizationRuleId": "gar-ez91t41jvi6tr8****",
      "Type": "System"
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2022-06-13OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Type
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈