1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateCcn)用于创建云联网(CCN)。
- 创建云联网同时可以绑定标签, 应答里的标签列表代表添加成功的标签。
- 每个账号能创建的云联网实例个数是有限的,详请参考产品文档。如果需要扩充请联系在线客服。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCcn。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
CcnName | 是 | String | CCN名称,最大长度不能超过60个字节。 示例值:test+name |
CcnDescription | 否 | String | CCN描述信息,最大长度不能超过100个字节。 示例值:test+description |
QosLevel | 否 | String | CCN服务质量,PT :白金,AU :金,AG :银,默认为AU 。示例值:PT |
InstanceChargeType | 否 | String | 计费模式,PREPAID :表示预付费,即包年包月,POSTPAID :表示后付费,即按量计费。默认:POSTPAID 。示例值:PREPAID |
BandwidthLimitType | 否 | String | 限速类型,OUTER_REGION_LIMIT 表示地域出口限速,INTER_REGION_LIMIT 为地域间限速,默认为OUTER_REGION_LIMIT 。预付费模式仅支持地域间限速,后付费模式支持地域间限速和地域出口限速。示例值:OUTER_REGION_LIMIT |
Tags.N | 否 | Array of Tag | 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}] 示例值:[{'Key': 'name', 'Value': '123'}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Ccn | CCN | 云联网(CCN)对象。 示例值:{'CcnId': 'ccn-xxxxxxxx', 'CcnName': 'ccn', 'CcnDescription': 'ccn', 'InstanceCount': 0, 'CreateTime': '', 'State': 'AVAILABLE', 'QosLevel': 'PT', 'InstanceChargeType': 'POSTPAID', 'BandwidthLimitType': 'OUTER_REGION_LIMIT', 'RoutePriorityFlag': True} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建一个CCN
创建一个云联网CCN实例
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCcn
<公共请求参数>
{
"CcnDescription": "test+description",
"Tags": [
{
"Value": "shanghai",
"Key": "city"
}
],
"CcnName": "test+name",
"QosLevel": "PT"
}
输出示例
{
"Response": {
"Ccn": {
"CcnId": "ccn-gjug0kul",
"CcnName": "test name",
"RoutePriorityFlag": false,
"CcnDescription": "test description",
"InstanceCount": 0,
"QosLevel": "PT",
"State": "AVAILABLE",
"InstanceChargeType": "POSTPAID",
"BandwidthLimitType": "OUTER_REGION_LIMIT",
"CreateTime": "2020-09-22 00:00:00",
"RouteTableFlag": true,
"RouteTableCount": 1,
"IsSecurityLock": true,
"RouteBroadcastPolicyFlag": true,
"TagSet": [
{
"Key": "city",
"Value": "shanghai"
}
]
},
"RequestId": "b8351d12-3c82-4d4b-9d88-972e02ca4620"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CreateCcnFailed | 创建云联网失败. 请重试你的请求,如果问题仍然存在,请联系腾讯云客服。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.ParameterMismatch | 参数值格式不匹配。 |
InvalidParameterValue.TagDuplicateKey | 标签键重复。 |
InvalidParameterValue.TagDuplicateResourceType | 重复的标签资源类型。 |
InvalidParameterValue.TagInvalidKey | 标签键无效。 |
InvalidParameterValue.TagInvalidKeyLen | 标签键长度无效。 |
InvalidParameterValue.TagInvalidVal | 标签值无效。 |
InvalidParameterValue.TagKeyNotExists | 标签键不存在。 |
InvalidParameterValue.TagNotAllocatedQuota | 标签没有分配配额。 |
InvalidParameterValue.TagNotExisted | 该标签不存在。 |
InvalidParameterValue.TagNotSupportTag | 不支持的标签。 |
InvalidParameterValue.TagResourceFormatError | 标签资源格式错误。 |
InvalidParameterValue.TagTimestampExceeded | 标签时间戳超配。 |
InvalidParameterValue.TagValNotExists | 标签值不存在。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.TagKeyExceeded | 标签键已达到上限。 |
LimitExceeded.TagKeyPerResourceExceeded | 每个资源的标签键已达到上限。 |
LimitExceeded.TagNotEnoughQuota | 没有足够的标签配额。 |
LimitExceeded.TagQuota | 标签配额已满,无法创建资源。 |
LimitExceeded.TagQuotaExceeded | 标签配额已达到上限。 |
LimitExceeded.TagTagsExceeded | 标签键的数目已达到上限。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation.NoRealNameAuthentication | 账号未实名。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.CopperCcnNotSupportedCreate | 当前账号不允许创建服务质量:铜云联网。 |
UnsupportedOperation.CopperCcnSupportedPrepaid | 服务质量:铜云联网仅支持创建预付费模式。 |
UnsupportedOperation.InsufficientFunds | 账户余额不足。 |
UnsupportedOperation.NotSupportedCreateTrafficMeteringTypeCcn | 不支持创建后付费流量计费类型云联网 |
UnsupportedOperation.PrepaidCcnOnlySupportBandwidthMetering | 预付费云联网只支持带宽计量类型 |
UnsupportedOperation.PrepaidCcnOnlySupportInterRegionLimit | 预付费云联网只支持地域间限速。 |
UnsupportedOperation.TagAllocate | 标签正在分配中。 |
UnsupportedOperation.TagFree | 标签正在释放中。 |
UnsupportedOperation.TagNotPermit | 标签没有权限。 |
UnsupportedOperation.TagSystemReservedTagKey | 不支持使用系统预留的标签键。 |
UnsupportedOperation.UserAndCcnChargeTypeNotMatch | 当前用户付费类型不支持创建所选付费类型的云联网。 |