You need to enable JavaScript to run this app.
导航

DescribeCloudConnectorAuthorizationRules

最近更新时间2024.01.09 07:43:30

首次发布时间2024.01.09 07:43:30

调用DescribeCloudConnectorAuthorizationRules查询符合条件的授权规则信息。

调用说明

DescribeCloudConnectorAuthorizationRules支持分页查询,初次调用接口进行分页查询时,仅需传入MaxResults以限制单页返回结果的条目,无需传入NextToken,查询结果会返回NextToken的值作为后续页查询的凭证。后续查询时请求参数NextToken传入上一次的NextToken的返回值,并设置MaxResults限制单页返回结果的条目即可。

请求参数

名称类型是否必选示例值描述
ActionStringDescribeCloudConnectorAuthorizationRules要执行的操作,取值:DescribeCloudConnectorAuthorizationRules。
VersionString2020-04-01API版本信息。
CloudConnectorIdStringcc-1sdsf334j51288***云连接器实例ID。您可调用DescribeCloudConnectors查询云连接器实例的ID信息。

Policy

String

accept

授权规则的访问策略。

  • accept:允许。

  • drop:拒绝。

AuthorizationRuleNameStringcciot-rule授权规则的名称。

AuthorizationRuleIds.N

String

AuthorizationRuleIds.1=ccrule-1sdsf334j51288****&AuthorizationRuleIds.1=ccrule-wrer9mfdjb0****

授权规则的ID。

  • 参数 - N:表示授权规则ID的序号。

  • 如不填,则默认查询指定云连接器实例下的全部符合条件的授权规则。

  • 多个ID之间用“&”分隔。

MaxResults

String

50

单次查询的数量,默认为 10,最大为100。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

分页查询凭证,用于标记分页的位置。
初次调用接口时无需设置,后续查询此参数取值为上一次API调用返回的NextToken的值。

返回数据

名称类型示例值描述

RequestId

String

0ED8D006-F706-4D23-88ED-E11ED28D****

请求ID。

NextToken

String

ca3fob2be03f84eb41b633f0d****

本次调用返回的查询凭证值,返回为空表示没有下一页。

AuthorizationRulesArray of Struct-授权规则的详细信息。具体参见 AuthorizationRule。

AuthorizationRule

名称类型示例值描述
AuthorizationRuleIdStringar-1sdsf334j51288****云连接器授权规则的ID。

AuthorizationRuleName

String

cciot-rule

云连接器授权规则的名称。

Description

String

cciot-rule_description

云连接器授权规则的描述。

DestinationCIdrBlock

String

47.0.XX.XX/24

访问目标地址。

Status

String

Available

云连接器授权规则的状态。

  • Available:可用。

  • Creating:创建中。

  • Deleting:删除中。

CloudConnectorIdSTringcc-xajjdvsdv云连接器实例的ID。

Policy

String

accept

访问策略。

  • accpet:允许。

  • drop:拒绝。

请求示例

GET /?Action=Action=DescribeCloudConnectorAuthorizationRules&Version=2020-04-01&CloudConnectorId=cc-1sdsf334j51288*** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401081413126A8D00DE458FC1****",
        "Action": "DescribeCloudConnectorAuthorizationRules",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202401081413126A8D00DE458FC1****",
        "NextToken": "",
        "AuthorizationRules": [
            {
                "AuthorizationRuleId": "ccrule-imd3sb3byigw8gbssx****",
                "AuthorizationRuleName": "cciot-rule",
                "DestinationCidrBlock": "47.0.XX.XX/24",
                "CloudConnectorId": "cc-1sdsf334j51288****",
                "Status": "Available",
                "Policy": "accept",
                "Description": "cciot-rule_description"
            },
            {
                "AuthorizationRuleId": "ccrule-imkwuji0npj48gbssx*****",
                "AuthorizationRuleName": "cciot-rule",
                "DestinationCidrBlock": "47.1.XX.XX/24",
                "CloudConnectorId": "cc-1sdsf334j51288****",
                "Status": "Available",
                "Policy": "drop",
                "Description": "cciot-rule_description"
            }
        ]
    }
}
}

错误码

此处仅展示当前API的错误码,更多错误码请参见公共错误码

HttpCode错误码错误信息描述
400DryRunOperationException raised to indicate a successfully authorized action when the DryRun flag is set to true.该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.AuthorizationRuleFilterIdsYou've reached the limit on the number of authorization rules filter IDs that you can describe.已达到可查询的授权规则筛选条件ID数量上限。