Purpose and features of the CreateInstance operation - Container Registry

Creates a Container Registry Enterprise Edition instance and automatically processes the payment.

Debugging

You can call this operation in OpenAPI Explorer to simplify debugging. OpenAPI Explorer automatically calculates the signature and generates sample SDK code.

Request parameters

Name	Type	Required	Example value	Description
Action	String	Yes	CreateInstance	The operation to perform. Set the value to `CreateInstance`.
Parameter.1.Code	String	Yes	InstanceType	The code of the first property for the Container Registry Enterprise Edition instance. Set the value to `InstanceType` to specify the instance type.
Parameter.1.Value	String	Yes	Standard	Specifies the value for the first property group of a Container Registry Enterprise Edition instance. Valid values: `Basic`: Basic instance `Advanced`: Advanced instance
Parameter.2.Code	String	Yes	InstanceName	The code of the second property for the Container Registry Enterprise Edition instance. Set the value to `InstanceName` to specify the instance name.
Parameter.2.Value	String	Yes	auto-create-instance	The value of the second property. This parameter specifies the name of the Container Registry Enterprise Edition instance. The name must be 3 to 30 characters in length and can contain lowercase letters, digits, and hyphens (-). The name cannot start or end with a hyphen.
Parameter.3.Code	String	Yes	Region	The code of the third property for the Container Registry Enterprise Edition instance. Set the value to `Region` to specify the region of the instance.
Parameter.3.Value	String	Yes	cn-shanghai	The value of the third property. This parameter specifies the region where the Container Registry Enterprise Edition instance is created. For more information about supported regions, see Supported regions.
Parameter.4.Code	String	Yes	DefaultOssBucket	The code of the fourth property for the Container Registry Enterprise Edition instance. Set the value to `DefaultOssBucket` to specify whether to use the default OSS bucket.
Parameter.4.Value	String	Yes	true	The value of the fourth property. This parameter specifies whether to use the default OSS bucket. Valid values: `true`: Use the default OSS bucket. `false`: Use a custom OSS bucket.
Parameter.5.Code	String	No	InstanceStorageName	The code of the fifth property for the Container Registry Enterprise Edition instance. Set the value to `InstanceStorageName` to specify the name of the custom OSS bucket.
Parameter.5.Value	String	No	my-customized-oss-bucket	The value of the fifth property. This parameter specifies the name of the custom OSS bucket. Note This parameter is required if you set the value of the fourth property to `false`.
Parameter.6.Code	String	No	image_scanner	The code of the sixth property for the Container Registry Enterprise Edition instance. Set the value to `image_scanner` to specify the security scan engine.
Parameter.6.Value	String	No	ACR	The value of the sixth property. This parameter specifies the security scan engine. Valid values: ACR: The default Trivy scan engine. SAS: The Security Center scan engine with enhanced capabilities.
Parameter.7.Code	String	No	NamespaceQuota	The code of the seventh property for the Container Registry Enterprise Edition instance. Set the value to `NamespaceQuota` to specify the number of additional namespaces to purchase.
Parameter.7.Value	String	No	10	The value of the seventh property. This parameter specifies the number of additional namespaces to purchase.
Parameter.8.Code	String	No	RepoQuota	The code of the eighth property for the Container Registry Enterprise Edition instance. Set the value to `RepoQuota` to specify the number of additional repositories to purchase.
Parameter.8.Value	String	No	1000	The value of the eighth property. This parameter specifies the number of additional repositories to purchase.
Parameter.9.Code	String	No	vpc_num	The code of the ninth property for the Container Registry Enterprise Edition instance. Set the value to `vpc_num` to specify the quota for VPC access control.
Parameter.9.Value	String	No	10	The value of the ninth property. This parameter specifies the quota for VPC access control.
ProductCode	String	Yes	acr	Product code The product code for Container Registry Enterprise Edition is acr.
SubscriptionType	String	Yes	Subscription	The billing method of the instance. A Container Registry Enterprise Edition instance requires the `Subscription` billing type.
ProductType	String	No	acr_ee_public_cn	The product type. Valid values: The product type used to create a Container Registry Enterprise Edition instance on the Alibaba Cloud International site is acr_ee_public_intl.
RenewPeriod	Integer	No	12	The auto-renewal period. Unit: months. Note This parameter is required if you set `RenewalStatus` to `AutoRenewal`.
Period	Integer	Yes	12	The subscription period. Unit: months. If you want to pay by year, enter a multiple of 12. Note This parameter is required when you create a subscription instance. If you set `RenewalStatus` to `AutoRenewal`, the value of this parameter must be greater than 0. Otherwise, auto-renewal does not take effect.
RenewalStatus	String	No	`AutoRenewal`	The renewal status. Valid values: `AutoRenewal`: Auto-renewal is enabled. `ManualRenewal`: Manual renewal is enabled. Default value: `ManualRenewal`.
ClientToken	String	No	XJSYHDKALSS****	A client token to ensure the idempotence of the request. The server checks for previous requests that have the same client token. If a match is found, the server returns the result of the previous request.

Returned Data

Name	Type	Example Value	Description
Code	String	Success	The status code of the request.
Data	Struct	Struct	The data returned.
InstanceId	String	cri-****	The ID of the instance.
OrderId	String	20857****	The ID of the created order.
Message	String	Successful!	`Code` The message that corresponds to the status code.
RequestId	String	A555455B-EA70-4114-AB0D-A35E75F8****	The ID of the request.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.

Examples

Sample request

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****
&<Common request parameters>

Sample response

XML format

<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 format

{
    "code":"Success",
    "IsSuccess": true,
    "data": {
        "instanceId":"cri-****",
        "orderId":"214*****"
    },
    "message":"Successful!",
    "requestId":"00AE3C85-048C-575E-A599-***********",
    "success":true
}

Error codes

For a list of error codes, see the Error Center.