Obtaining the Instance Creation Progress

Function

This API is used to obtain the instance creation progress.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/{projectId}/instances/{instanceId}/process

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
projectId	Yes	String	Project set ID.
instanceId	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-AUTH-TOKEN	Yes	String	User token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
instance	instance object	Instance.
currentTime	Integer	Current time.
instance_id	String	Instance ID.
name	String	Instance name.
start_time	Integer	Start time.
taken_time	Integer	Time used for provisioning an instance.
end_time	Integer	End time.
progress	Integer	Progress.
status	String	Instance status. Options: CREATING, RUNNING, and CREATE_FAILED.
item	Array of item objects	Sub-service object set.

**Table 4** instance
Parameter	Type	Description
instanceId	String	Instance ID.
name	String	Instance name.
status	String	Instance status. Options: CREATING, RUNNING, and CREATE_FAILED.
connectAddress	String	Connection address.
connectAddressWithPP	String	Source address for transparent transmission (for next-generation APIC only).
mgmtConnectAddress	String	Connection address for the management plane to access the data plane (for the next generation only).
mgmtExtraConnectAddress	String	Connection address for the management plane to access the data plane (for next-generation FDI only)
port	String	Port (deprecated).
conAmount	String	Number of connections (for the connection pool mode only).
type	String	Instance type. - basic - professional - enterprise - platinum
location	String	Location (deprecated).
productId	String	Product ID.
engine	String	Engine (deprecated).
engineVersion	String	Engine version (deprecated).
chargingMode	Integer	Billing mode.
description	String	Description.
errorCode	String	Error code.
errorMessage	String	Error message.
resTenantId	String	Resource set ID of the resource tenant.
resDomainId	String	Domain ID of the resource tenant.
resVpcId	String	VPC ID of the resource tenant.
resSubnetId	String	Subnet ID of the resource tenant.
resSecurityGroupId	String	Security group ID of the resource tenant.
tenantId	String	Resource set ID of the tenant.
tenantVpcId	String	Tenant VPC ID.
tenantSubnetId	String	Tenant subnet ID.
tenantSecurityGroupId	String	Tenant security group ID.
userId	String	User ID.
userName	String	Username.
domainId	String	Domain ID.
virtualRouterId	String	Virtual route ID.
orderId	String	Order ID.
createdAt	Integer	Creation time.
updatedAt	Integer	Update time.
deletedAt	String	Deletion time.
availableZones	String	AZ.
maintainBegin	String	Start time of the maintenance time window.
maintainEnd	String	End time of the maintenance time window.
taskStatus	String	Task status.
noPasswordAccess	Boolean	Access without password.
accessUser	String	Access user.
publicipId	String	Public network access IP address ID.
publicipAddr	String	Public network access IP address.
publicipBounded	Boolean	Whether to bind a public IP address.
outZones	String	Ignore. This field is invalid.
resourceList	String	Resource list.
nameLike	String	Ignore. This field is invalid.
instanceIdLike	String	Ignore. This field is invalid.
specCode	String	Specification code.
statusIncluded	String	Ignore. This field is invalid.
epId	String	Enterprise project ID.
resLeakStatus	String	Residual resource status.
tagEntries	String	Tag.
epIds	String	System tags.
typeExcluded	String	Ignore. This field is invalid.
ipv6Enable	Boolean	Enable IPv6.
ipv6ConnectAddress	String	IPv6 connection address.
bandwidths	Integer	Bandwidth.
ingressBandwidthSize	String	Ingress bandwidth (next generation).
resInstanceClusterId	String	ID of the cluster where the instance is located.
scope	String	Region. Options: center and edge.
cpuArch	String	CPU architecture. Options: arm and x86.
cryptoType	String	Cryptographic algorithm.
rocketmqEnable	Boolean	Whether to enable RocketMQ.
externalElbEnable	Boolean	Whether to enable the external ELB.
ltsLogGroupId	String	LTS log group ID.
demondPay	Boolean	Pay-per-use billing or not.
prePay	Boolean	Prepayment or not.
epIdOrDefault	String	Enterprise project ID.

**Table 5** item
Parameter	Type	Description
name	String	Name.
start_time	Integer	Start time.
end_time	Integer	End time.
status	String	Instance status. Options: CREATING, RUNNING, and CREATE_FAILED.
taken_time	Integer	Time used for provisioning an instance.
progress	Integer	Progress.
error_msg	String	Error details.
error_code	String	Error code.

Example Requests

None

Example Responses

Status code: 200

Instance creation progress.

{
  "instance" : {
    "instanceId" : "b037d389-62a4-464a-8461-c88797ad4f23",
    "name" : "roma-2222",
    "status" : "CREATING",
    "connectAddress" : null,
    "connectAddressWithPP" : null,
    "mgmtConnectAddress" : null,
    "mgmtExtraConnectAddress" : null,
    "port" : null,
    "conAmount" : "25",
    "type" : "basic",
    "location" : null,
    "productId" : "00300-30101-0--0",
    "engine" : "ROMA",
    "engineVersion" : "1.0.0",
    "chargingMode" : 1,
    "description" : null,
    "errorCode" : "JOB-0d42a6bc-3f3d-446a-8351-00a110f56137",
    "errorMessage" : null,
    "resTenantId" : "#",
    "resDomainId" : "#",
    "resVpcId" : "#",
    "resSubnetId" : "#",
    "resSecurityGroupId" : "#",
    "tenantId" : "c29445cce74b445682de4fcf3102cec4",
    "tenantVpcId" : "f33728c1-e774-4a9b-a0bb-30b840645628",
    "tenantSubnetId" : "f65009c8-7009-403c-abdf-3100f9817762",
    "tenantSecurityGroupId" : "272338c9-b3ee-41ae-a2b6-3942f31030da",
    "userId" : "9167977213674566b8d89570083e2ba0",
    "userName" : "zhangyue",
    "domainId" : null,
    "virtualRouterId" : null,
    "orderId" : "20250306120108660165176",
    "createdAt" : 1741262473785,
    "updatedAt" : 1741262475453,
    "deletedAt" : null,
    "availableZones" : "[\"az0.dc0\"]",
    "maintainBegin" : "12:01:13",
    "maintainEnd" : "12:01:13",
    "taskStatus" : null,
    "noPasswordAccess" : false,
    "accessUser" : null,
    "publicipId" : null,
    "publicipAddr" : null,
    "publicipBounded" : false,
    "outZones" : null,
    "resourceList" : null,
    "nameLike" : null,
    "instanceIdLike" : null,
    "specCode" : "roma.basic.001",
    "statusIncluded" : null,
    "epId" : "0",
    "resLeakStatus" : null,
    "tagEntries" : null,
    "epIds" : null,
    "typeExcluded" : null,
    "ipv6Enable" : false,
    "ipv6ConnectAddress" : null,
    "bandwidths" : 0,
    "ingressBandwidthSize" : null,
    "resInstanceClusterId" : "#",
    "scope" : "center",
    "cpuArch" : "x86_64",
    "cryptoType" : null,
    "rocketmqEnable" : false,
    "externalElbEnable" : false,
    "ltsLogGroupId" : null,
    "demondPay" : true,
    "prePay" : false,
    "epIdOrDefault" : "0"
  },
  "currentTime" : 1741262503894,
  "instance_id" : "b037d389-62a4-464a-8461-c88797ad4f23",
  "name" : "roma-2222",
  "start_time" : 1741262473785,
  "taken_time" : 1,
  "end_time" : 0,
  "progress" : 0,
  "status" : "creating",
  "item" : [ {
    "name" : "mqs",
    "start_time" : 0,
    "end_time" : 0,
    "status" : "creating",
    "taken_time" : 0,
    "progress" : 0,
    "error_msg" : "",
    "error_code" : ""
  }, {
    "name" : "lvs",
    "start_time" : 1741262473785,
    "end_time" : 0,
    "status" : "creating",
    "taken_time" : 1,
    "progress" : 0,
    "error_msg" : "",
    "error_code" : ""
  } ]
}