创建云连接器实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ISP | string | 是 | 指定云连接器实例的运营商。取值:
| mobile |
APN | string | 是 | 运营商 APN ID。 | CMWAP |
IoTCloudConnectorName | string | 否 | 云连接器实例的名称。 名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。 | test |
IoTCloudConnectorDescription | string | 否 | 云连接器实例描述信息。 长度为 2~256 个字符,必须以字母或中文开头,但开头不能为 | test |
WildcardDomainEnableddeprecated | boolean | 否 | 是否开启泛域名功能。
说明
泛域名默认开启,本字段传值无效。
| true |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
| false |
RegionId | string | 是 | 云连接器实例所在的地域 ID。 您可以通过调用 ListRegions 接口获取地域 ID。 | cn-hangzhou |
ResourceUid | long | 否 | 云连接器实例使用者 ID。 | 132193271328**** |
Type | string | 否 | Standard |
返回参数
示例
正常返回示例
JSON
格式
{
"IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Forbidden.RAM | Ram user does not have permission to perform this operation. | RAM用户无权限执行此操作。 |
400 | OperationDenied.ApnDisabledWildcardDomain | The operation is not allowed because of apn disabled wildcardDomain. | - |
400 | OperationDenied.NotOpenIoTCloudConnectorService | The operation is not allowed because of not open iotcc service. | - |
400 | IllegalParamFormat | The param is illegal. | - |
400 | QuotaExceeded.iotccInstanceLimit | The quota of IoTCCPerUser is exceeded | - |
400 | ResourceNotEnough.APN | The specified resource of APN is not enough. | APN资源不足 |
400 | IncorrectStatus.APNNotReady | The status of APN is incorrect. | APN当前没有准备好,请稍等。 |
400 | OperationDenied.ApnNotSupportBasicType | The operation is not allowed because of apn do not support basic type cciot instance. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-04-23 | OpenAPI 错误码发生变更 | 看变更集 | ||||
| ||||||
2023-03-10 | OpenAPI 错误码发生变更 | 看变更集 | ||||
| ||||||
2021-11-18 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|