首页 云连接器 开发参考 API参考 API目录 云连接器 CreateIoTCloudConnector - 创建云连接器实例

CreateIoTCloudConnector - 创建云连接器实例

更新时间: 2023-04-23 20:18:05

创建云连接器实例。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
iotcc:CreateIoTCloudConnectorWrite
  • UIS
    acs:iotcc:{#regionId}:{#accountId}:cloudconnector/*

请求参数

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

指定云连接器实例的运营商。取值:

  • telecom:中国电信。
  • mobile:中国移动。
  • unicom:中国联通。
mobile
APNstring

运营商APN ID。

CMWAP
IoTCloudConnectorNamestring

云连接器实例的名称。

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

test
IoTCloudConnectorDescriptionstring

云连接器实例描述信息。

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

test
WildcardDomainEnabledboolean

是否开启泛域名功能。

  • true(默认值):开启。
  • false:关闭。
说明泛域名默认开启,本字段传值无效。
true
ClientTokenstring

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

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

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

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

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

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

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

cn-hangzhou
ResourceUidlong

云连接器实例使用者ID。

132193271328****
Typestring

云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:

  • Basic:基础版。

  • Standard:标准版。

云连接器实例默认创建标准版,如果需要创建基础版实例,请提交工单申请。

Standard

返回参数

名称类型描述示例值
object

返回信息列表。

IoTCloudConnectorIdstring

云连接器实例ID。

iotcc-bp1odcab8tmno0hdq****
RequestIdstring

请求ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

示例

正常返回示例

JSON格式

{
  "IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400OperationDenied.ApnDisabledWildcardDomainThe operation is not allowed because of apn disabled wildcardDomain.-
400OperationDenied.NotOpenIoTCloudConnectorServiceThe operation is not allowed because of not open iotcc service.-
400IllegalParamFormatThe param is illegal.-
400QuotaExceeded.iotccInstanceLimitThe quota of IoTCCPerUser is exceeded-
400ResourceNotEnough.APNThe specified resource of APN is not enough.APN资源不足
400IncorrectStatus.APNNotReadyThe status of APN is incorrect.APN当前没有准备好,请稍等。
400OperationDenied.ApnNotSupportBasicTypeThe operation is not allowed because of apn do not support basic type cciot instance.-

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

变更历史

变更时间变更内容概要操作
2023-04-23OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-03-10OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2021-11-18OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
阿里云首页 云连接器 相关技术圈