CreateInstance

调用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配置,取值:

  • Basic:基础实例

  • Standard:标准版实例

  • Advanced:高级版实例

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。取值:

  • true:使用默认OSS Bucket。

  • false:使用自定义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,此项必须设置。

Parameter.6.Code

String

image_scanner

容器镜像服务企业版第6组属性的Code配置,设置为image_scanner,表示容器镜像服务企业版使用的安全扫描引擎。

Parameter.6.Value

String

ACR

容器镜像服务企业版第6组属性的Value配置,表示容器镜像服务企业版使用的安全扫描引擎。取值:

  • ACR:使用默认提供的Trivy扫描引擎。

  • SAS:使用能力增强的云安全扫描引擎。

Parameter.7.Code

String

NamespaceQuota

容器镜像服务企业版第7组属性的Code配置,设置为NamespaceQuota,表示购买容器镜像服务企业版额外增加的命名空间配额。

Parameter.7.Value

String

10

容器镜像服务企业版第7组属性的Value配置,表示按需额外增加的命名空间配额数。

Parameter.8.Code

String

RepoQuota

容器镜像服务企业版第8组属性的Code配置,设置为RepoQuota,表示购买容器镜像服务企业版额外增加的仓库配额。

Parameter.8.Value

String

1000

容器镜像服务企业版第8组属性的Code配置,表示按需额外增加的仓库配额。

ProductCode

String

acr

产品代码。

创建容器镜像服务企业版实例产品代码为acr。

SubscriptionType

String

Subscription

付费类型。

创建容器镜像服务企业版实例需设置为Subscription,预付费类型。

ProductType

String

acr_ee_public_cn

产品类型,取值:

创建容器镜像服务企业版实例中国站产品类型为acr_ee_public_cn。

RenewPeriod

Integer

12

自动续费周期, 单位为月。

说明

当设置RenewalStatusAutoRenewal时,必须设置。

Period

Integer

12

预付费周期。单位为月,按年付费产品请输入12的整数倍。

说明

当创建预付费实例时,必须设置。

RenewalStatus

String

ManualRenewal

自动续费状态,取值:

  • AutoRenewal:自动续费。

  • ManualRenewal:手动续费。

默认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

本次请求是否成功。取值:

  • true:请求成功。

  • false:请求失败。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateInstance
&Parameter.1.Code=InstanceType
&Parameter.1.Value=Advanced
&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
}

错误码

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