调用CreateInstance创建一个容器镜像实例,并自动支付。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateInstance | 要执行的操作。取值为CreateInstance 。 |
Parameter.1.Code | String | 是 | InstanceType | 容器镜像服务企业版第1组属性的Code配置,设置为InstanceType ,表示容器镜像服务企业版实例的类型。 |
Parameter.1.Value | String | 是 | Standard | 容器镜像服务企业版的第1组属性的Value配置,取值:
|
Parameter.2.Code | String | 是 | InstanceName | 容器镜像服务企业版第2组属性的Code配置,设置为InstanceName ,表示容器镜像服务企业版实例的名称。 |
Parameter.2.Value | String | 是 | auto-create-instance | 设置为容器镜像服务企业版第2组属性的Value配置,配置内容表示容器镜像服务企业版实例的名称。 设置容器镜像服务企业版实例名称需要满足的规则为:长度为3~30个字符,可使用小写字母、数字、分隔符 (不能在首位或末位)。 |
Parameter.3.Code | String | 是 | Region | 容器镜像服务企业版第3组属性的Code配置,设置为Region ,表示容器镜像服务企业版实例的地域。 |
Parameter.3.Value | String | 是 | cn-shanghai | 容器镜像服务企业版第3组属性的Value配置,容器镜像服务企业版开放的地域。关于企业版开放地域的取值,请参见开服地域。 |
Parameter.4.Code | String | 是 | DefaultOssBucket | 容器镜像服务企业版第4组属性的Code配置,设置为DefaultOssBucket ,表示容器镜像服务企业版实例是否使用默认的OSS Bucket。 |
Parameter.4.Value | String | 是 | true | 容器镜像服务企业版的第4组属性的Value配置,表示容器镜像服务企业版实例是否使用默认的OSS Bucket。取值:
|
Parameter.5.Code | String | 是 | InstanceStorageName | 容器镜像服务企业版第5组属性的Code配置,设置为InstanceStorageName ,表示容器镜像服务企业版使用的自定义OSS Bucket名称。 |
Parameter.5.Value | String | 是 | my-customized-oss-bucket | 容器镜像服务企业版的第5组属性的Value配置,表示设置的自定义OSS Bucket名称。
说明 当第4组属性的值配置为
false 时,表明容器镜像服务企业版实例使用自定义的OSS Bucket,此项必须设置。
|
ProductCode | String | 是 | acr | 产品代码。 容器镜像服务企业版产品代码为acr。 |
SubscriptionType | String | 是 | Subscription | 付费类型。 容器镜像服务企业版需设置为 |
ProductType | String | 否 | acr_ee_public_cn | 产品类型,取值: 容器镜像服务企业版中国站产品类型为acr_ee_public_cn。 |
RenewPeriod | Integer | 否 | 12 | 自动续费周期, 单位为月。
说明 当设置
RenewalStatus 为
AutoRenewa l时,必须设置。
|
Period | Integer | 是 | 12 | 预付费周期。 单位为月,按年付费产品请输入12的整数倍。
说明 当创建预付费实例时,必须设置。
|
RenewalStatus | String | 否 | ManualRenewal | 自动续费状态,取值:
默认 |
ClientToken | String | 否 | XJSYHDKALSS**** | 客户端幂等参数,服务端会查询是否有相同ClientToken的请求,如果有,直接返回上次调用结果。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | Success | 本次请求的状态码。 |
data | Struct | Struct | 本次请求的返回信息。 |
instanceId | String | cri-**** | 本次请求的实例ID。 |
orderId | String | 20857**** | 创建成功的订单ID。 |
message | String | Successful! | Code 对应的状态码信息。 |
requestId | String | A555455B-EA70-4114-AB0D-A35E75F8**** | 本次请求的ID。 |
success | Boolean | true | 本次请求是否成功。取值:
|
示例
请求示例
http(s)://[Endpoint]/?Action=CreateInstance
&Parameter.1.Code=InstanceType
&Parameter.1.Value=Standard
&Parameter.2.Code=InstanceName
&Parameter.2.Value=auto-create-instance
&Parameter.3.Code=Region
&Parameter.3.Value=cn-shanghai
&Parameter.4.Code=DefaultOssBucket
&Parameter.4.Value=true
&Parameter.5.Code=InstanceStorageName
&Parameter.5.Value=my-customized-oss-bucket
&ProductCode=acr
&SubscriptionType=Subscription
&ProductType=acr_ee_public_cn
&RenewPeriod=12
&Period=12
&RenewalStatus=ManualRenewal
&ClientToken=XJSYHDKALSS****
&<公共请求参数>
正常返回示例
XML
格式
<code>Success</code>
<IsSuccess>true</IsSuccess>
<data>
<instanceId>cri-****</instanceId>
<orderId>214*****</orderId>
</data>
<message>Successful!</message>
<requestId>00AE3C85-048C-575E-A599-***********</requestId>
<success>true</success>
JSON
格式
{
"code":"Success",
"IsSuccess": true,
"data": {
"instanceId":"cri-****",
"orderId":"214*****"
},
"message":"Successful!",
"requestId":"00AE3C85-048C-575E-A599-***********",
"success":true
}
错误码
访问错误中心查看更多错误码。