文档

CreateAuthorizationRule - 创建授权规则

更新时间:

创建授权规则。

调试

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

授权信息

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

请求参数

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

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
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
Policystring

访问策略。取值:

  • Permit:允许。
  • Deny:拒绝。
Permit
SourceCidrsarray

源 CIDR 地址块。最多支持 20 个源 CIDR 地址块。

string

源 CIDR 地址块。最多支持 20 个源 CIDR 地址块。

192.168.XX.XX
AuthorizationRuleNamestring

授权规则名称。

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

rule01
AuthorizationRuleDescriptionstring

授权规则描述。

长度为 2~256 个字符,开头必须为大小写英文字母或中文,但不能为http://https://

rule01
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-426655440000
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会创建授权规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接创建授权规则。
false
RegionIdstring

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

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

cn-hangzhou

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

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

授权规则 ID。

ar-1234abcb8tmno0hdq****

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "AuthorizationRuleId": "ar-1234abcb8tmno0hdq****"
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400OperationDenied.DomainFeatureDisabledThe operation is not allowed because of domain feature disabled.-
400IllegalParam.DestinationThe param of Destination is illegal.Destination无效
400ResourceAlreadyExist.AuthorizationRuleThe specified resource of AuthorizationRule already exists.规则已经存在
400Conflict.ParamThe param is conflict.-
400Conflict.CidrThe cidr is conflict.-
400ResourceNotFound.IoTCloudConnectorThe param of IoTCloudConnectorId is illegal.IoTCloudConnectorId参数非法
400QuotaExceeded.sourceCidrLimitThe quota of SourceCidrsPerAuthorizationRule is exceededSourceCidrsPerAuthorizationRule quota超出
400IllegalParamThe param is illegal.参数非法
400QuotaExceeded.authorizationRuleInstanceLimitThe quota of AuthorizationRulePerIotCC is exceeded.单个云连接器的授权规则配额超限。
400IllegalParamFormatThe param is illegal.-
400ResourceInConfiguring.IoTCloudConnectorThe specified resource of IoTCloudConnector is configuring, please try again later.iotcc状态非稳态,或者锁冲突
400OperationDenied.DomainInHumanNetworkThe operation is not allowed because of domain or CIDR in human network.配置的域名或者网段在人联网里面,不被允许。
400OperationDenied.CIDRMaskTooLargeThe operation is not allowed because of CIDR too large.CIDR掩码太大了。
400OperationDenied.CC5GInstanceNotSupportThe operation is not allowed because of CC5G instance not support.CC5G托管实例不支持此操作。
400IllegalParam.AuthorizationRule.DestinationTypeThe param of DestinationType is illegal.-

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

变更历史

变更时间变更内容概要操作
2023-03-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2021-11-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)