接口功能介绍
订购企业版实例
接口约束
仅限企业版实例使用
URI
POST /v1/subscribeEnterpriseInstance
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | String | 类型 | application/json | |
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceName | 是 | String | 实例名称(5-30个字符,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头,数字或小写字母结尾) | my-instance | |
instanceType | 是 | String | 实例类型(企业版:enterprise-basic) | enterprise-basic | |
crUserName | 是 | String | 用户名称(5-30个字符,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头,数字或小写字母结尾) | my-user | |
crUserPassword | 是 | String | 用户密码(密码长度在8-50个字符,且需包含至少一个大写字母、一个小写字母、一个数字和一个特殊字符) | Abc@12345 | |
regionId | 是 | String | 资源池UUID | d8bbd132b53a11e9b0e40242ac110002 | |
ossBucket | 是 | String | 对象存储的Bucket名称(需要开通对象存储(原生版)I型,并创建Bucket) | mybucket | |
reqType | 是 | String | 天翼云,值为2 | 2 | |
billMode | 是 | String | 计费模式(按周期计费为1,按需计费为2,目前只支持按周期计费) | 1 | |
cycleType | 是 | String | 订购周期类型(3为按月计费) | 3 | |
cycleCnt | 是 | Integer | 订购时长(单位为月) | 3 | |
repositoryExtraQuota | 否 | Integer | 额外仓库配额(默认已包含仓库配额1000,如果配额依然不足,您可以按需额外增加仓库配额包。仓库配额由容器镜像和HelmChart共享。 单项费用:每增加1000个仓库配额,额外需100元/月。详见计费说明) |
0 | |
namespaceExtraQuota | 否 | Integer | 额外命名空间配额(默认已包含命名空间配额15,如果配额依然不足,您可以按需额外增加命名空间配额包。命名空间配额由配额由容器镜像和HelmChart共享。 单项费用:每增加5个仓库配额,额外需25元/月。详见计费说明) |
0 | |
autoRenewStatus | 否 | Boolean | 是否自动续期(默认为false) | false | |
autoRenewCycleType | 否 | String | 自动续期单位(目前只提供按月计费,该值只能为3) | 3 | |
autoRenewCycleCount | 否 | Integer | 自动续期时长(目前只提供按月计费,代表自动续期多少个月) | 3 | |
autoPay | 否 | Boolean | 是否自动付款(默认为false) | false |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应码 | 0 | |
message | String | 返回信息 | ||
error | String | 错误信息 |
枚举参数
无
请求示例
请求url
POST https://[endpoint].ctapi.ctyun.cn/v1/subscribeEnterpriseInstance
请求头header
{
"Content-Type":"application/json"
}
请求体body
{
"instanceName":"my-instance",
"instanceType":"enterprise-basic",
"crUserName":"my-user",
"crUserPassword":"Abc@12345",
"regionId":"d8bbd132b53a11e9b0e40242ac110002",
"ossBucket":"mybucket",
"reqType":"2",
"billMode":"1",
"cycleType":"3",
"cycleCnt":"3"
}
响应示例
{
"message":"请求成功",
"returnObj":1669023179152674818,
"statusCode":0
}
状态码
请参考 状态码
错误码
请参考 错误码