API Introduction

Obtain the latest cloud server status based on the cloud server ID, especially the disk mounting information.

API Restrictions

Limitations: This API (beta) is only available to resource pools including Lhasa 3, Shanghai 7, Guangzhou 6, Chenzhou 2, Changsha 3, Beijing 5, Inner Mongolia 6, Nanjing 3, Chongqing 2, Hefei 2, Chengdu 4, Jinzhong, Kunming 2, Urumchi 27, Fuzhou 25, Hengyang 3, Changsha 37, Zhangjiajie 2, North 2, Beijing 1 (Center Enterprises), East 1, Shanghai 32, Shanghai 33, and Shanghai 36.
This applies to the old version of API operations and may not be applicable in the future. We recommend you use the new version, which is more standard and covers more scenarios.

URI

<span lang="EN-US">POST /v4/ecs/backup-instance-query</span>

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource pool ID. You can callregionIDto query the latest resource pool list of eSurfing Cloud.	888888c8888888e8a8888888ac888888
projectID	No	String	Enterprise project ID.	0
ID	Yes	String	Cloud server ID.	88f888ea-88ff-88ec-a8bc-888888888fe8

Response Parameter

Parameter	Parameter Type	Description	Example	Lower-level Object
statusCode	Integer	Return status code (800 indicates success, 900 indicates failure).	800
errorCode	String	Business code, a three-segment code in the format of product.module.code. Refer toError Codesfor more details.
message	String	Error description upon a failure, usually in English.
description	String	Error description upon a failure, usually in Chinese.
returnObj	Object	Response Parameters		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example	Lower-level Object
currentCount	Integer	Number of records on current page.	1
totalCount	Integer	Total number of records.	10
totalPage	Integer	Total number of pages.	1
results	Array of Objects	Pagination details.		results

Table results

Parameter	Parameter Type	Description	Example	Lower-level Object
projectID	String	Enterprise project ID.	0
availabilityZone	String	Availability zone name.	SERIES-7-ZONE
attachedVolume	Array of Strings	List of EVS disks of the cloud server.	["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"]
addresses	Array of Objects	IP address list.		addresses
resourceID	String	Cloud server ID.	f88bc88a88a888e8a88bf88888888888
ID	String	Cloud server ID.	88f888ea-88ff-88ec-a8bc-888888888fe8
displayName	String	The name of the cloud server displayed.	xxx-8888
name	String	Cloud Server Name	xxx-8888
osType	Integer	Operating system. Value range: 1: Linux, 2: Windows, 3: RedHat, 4: Ubuntu, 5: CentOS, and 6: oracle	5
vmState	String	Cloud server status. Value range: backingup, creating, expired, freezing, rebuild, restarting, running, starting, stopped, stopping, and master_order_creating .	running
expiredTime	String	Expiration Time	2023-04-19T09:37:53Z
availableDay	Integer	Available time (Day).
updatedAt	String	Update At	2022-10-19T09:37:53Z
createdAt	String	Created At	2022-10-19T09:37:53Z
zabbixName	String	Name of monitored object.	8a8fdc88-b8a8-88bb-888f-8b88888c88f8
securityGroup	Array of Objects	Security group list.		securityGroup
floatingV6UUID	String	UUID of the elastic IPv6 address.
privateIP	String	Intranet IPv4 Address	10.0.0.1
privateIPv6	String	Intranet IPv6 address.	888:8:8c8:8888:bee8:88d8:c8a8:888
nicList	Array of Objects	ENI list.		nicList
vipInfoList	Array of Objects	Virtual IP (VIP) info list.		vipInfoList
vipCount	Integer	VIP quantity.	1
affinityGroup	Objects	Cloud server group info.		affinityGroup
image	Object	Image info.		image
flavor	Object	Specification.		flavor
onDemand	Boolean	Payment method. Value range: false: subscription. true: pay-as-you-go.	true
vpcName	String	VPC name.	vpc-xxx
vpcID	String	vpc ID	vpc-xxx8xxxxxx
fixedIP	Array of Strings	Intranet IP Address	["10.0.0.1"]
floatingIP	String	Public IP Address
subnetIDList	Array of Strings	Subnet ID list.	["subnet-0yy0yy0yyy"]
keypairName	String	Key pair name.
volumes	Object	Disk Info		volume

Table nicList

Parameter	Parameter Type	Description	Example
IPv4Address	String	IPv4 Address	10.0.0.1
IPv6Address	Array of Strings	IPv6 address list.	["888:8:8c8:8888:bee8:88d8:c8a8:888"]
subnetID	String	Subnet ID.	subnet-0yy6yy2yyy
subnetCidr	String	Subnet CIDR block.	10.0.0.1/24
isMaster	Boolean	Indicate whether this is the master ENI. Value range: true: master ENI. false: extended ENI.	true
gateway	String	Gateway address.
nicID	String	NIC ID	port-5ttttt9tt8
securityGroup	Array of Strings	Security group ID list.	["sg-xxxxxxxx7x"]

Table secGroupList

Parameter	Parameter Type	Description	Example	Lower-level Object
securityGroupID	String	Security group ID.	sg-xxxxxxxx7x
securityGroupName	String	Security Group Name	Default-Security-Group

Table vipInfoList

Parameter	Parameter Type	Description	Example
vipID	String	VIP ID.	havip-fw1kb30m78
vipAddress	String	Virtual IP Address	192.168.0.58
vipBindNicIP	String	IPv4 address of the ENI bound with the VIP.	192.168.0.62
vipBindNicIPv6	String	IPv6 address of the ENI bound with the VIP.	100:1:179:b400:d7ea:3e70:7966:2ba5
nicID	String	NIC ID	port-omdlwvr4sm

Table affinityGroup

Parameter	Parameter Type	Description	Example
policy	String	Cloud server group policy.	soft-affinity
affinityGroupName	String	Name of the cloud server group.	group-10274
affinityGroupID	String	Cloud server group ID.	682c01af-1eaf-400b-570f-05734a00619d

Table image

Parameter	Parameter Type	Description	Example	Lower-level Object
imageID	String	Image ID.	b88888b8-ff88-8888-b88f-8c8fbc888b88
imageName	String	Image Name	CentOS7.5.v1-20210303

Table flavor

Parameter	Parameter Type	Description	Example
flavorID	String	Specification ID.	8f8ba888-88e8-ea88-ea8b-888888dded88
specName	String	Specification Name	s7.medium.2
vcpu	Integer	VCPU	1
ram	Integer	Memory	2048
gpuType	String	GPU type. Value range: T4, V100, V100S, A10, A100, atlas 300i pro, and mlu370-s4. The supported types increase as the feature upgrade.
gpuCount	Integer	GPU quantity.	1
gpuName	String	GPU Name
momery	Integer	GPU video memory.

Table addressList

Parameter	Parameter Type	Description	Example
addr	String	IP Address	192.168.0.62
version	Integer	IP Version	4
type	String	Network type. Value range: fixed: Intranet. floating: Internet.	fixed

Table volume

Parameter	Parameter Type	Description	Example
is_bootable	Boolean	Indicate whether the disk is a startup disk. Value range: true and false.	true
is_encrypted	Boolean	Indicate whether the disk is an encrypted disk. Value range: true: encrypted. false: not encrypted.	false
is_expired	Boolean	Indicate whether the cloud server has expired. Value range: true: expired. false: not expired.	false
size	Integer	EVS disk size (GB).	40
type	String	EVS disk type. Value range: SATA: general IO. SAS: high IO. SSD: ultra-high IO. SSD-genric: general-purpose SSD. FAST-SSD: express SSD.
id	String	EVS ID	0de747ae-ee9b-4966-bba2-4023803ac62e
name	String	EVS Name	vol-test01
status	String	EVS disk status.	in-use

Sample Request

Request Body

  "regionID": "888888c8888888e8a8888888ac888888",

  "projectID": "0",

  "ID": "8a8fdc88-b8a8-88bb-888f-8b88888c88f8"

Response Example

                  "returnObj": {

                                     "currentCount": 1,

                                     "totalCount": 1,

                                     "totalPage": 1,

                                     "results": [{

                                                       "affinityGroup": null,

                                                       "availableDay": 176,

                                                       "availabilityZone": "az1",

                                                       "addresses": [{

                                                                         "vpcName": "vpc-6cd0",

                                                                         "addressList": [{

                                                                                            "version": 4,

                                                                                            "type": "fixed",

                                                                                            "addr": "192.168.0.94"

}]

}],

                                                       "projectID": "0",

                                                       "image": {

                                                                         "imageName": "CentOS7.5.v1-20210303",

                                                                         "imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08"

},

                                                       "updatedAt": "2023-01-12T07:50:54Z",

                                                       "fixedIP": ["192.168.0.94"],

                                                       "vpcName": "vpc-6cd0",

                                                       "vipInfoList": null,

                                                       "zabbixName": "41400ab5-562f-5db5-6b7c-8671a3b37786",

                                                       "osType": 5,

                                                       "displayName": "ghy",

                                                       "flavor": {

                                                                         "memory": null,

                                                                         "vcpu": 1,

                                                                         "ram": 1024,

                                                                         "gpuCount": null,

                                                                         "specName": "s7.small.1",

                                                                         "gpuName": null,

                                                                         "flavorID": "5622ce59-da34-cb43-ca0d-eef2a51475b3",

                                                                         "gpuType": null

},

                                                       "ID": "41400ab5-562f-5db5-6b7c-8671a3b37786",

                                                       "createdAt": "2023-01-09T03:23:57Z",

                                                       "keypairName": "",

                                                       "vmState": "stopped",

                                                       "floatingV6UUID": null,

                                                       "vpcID": "vpc-ttxdh00rjf",

                                                       "attachedVolume": ["0de747ae-ee9b-4966-bba2-4023803ac62e",

                                                                                                                                   "41703f2d-4672-4445-93e1-e4f158c787e1"],

                                                       "name": "ghy-3",

                                                       "onDemand": false,

                                                       "floatingIP": "",

                                                       "resourceID": "b4c575fcd760499f8896619630151700",

                                                       "securityGroup": [{

                "securityGroupName": "Default-Security-Group",

                "securityGroupID": "sg-767voa4wxg"

}],

                                                       "privateIP": "192.168.0.94",

                                                       "privateIPv6": "",

                                                       "expiredTime": "2023-07-09T03:25:34Z",

                                                       "subnetIDList": ["subnet-ty87lkna06"],

                                                       "vipCount": 0,

                                                       "volumes": [{

                                                                         "status": "in-use",

                                                                         "is_bootable": true,

                                                                         "name": "ghy-3-volume_000",

                                                                         "id": "0de747ae-ee9b-4966-bba2-4023803ac62e",

                                                                         "type": "SATA-public",

                                                                         "is_expired": false,

                                                                         "is_encrypted": false,

                                                                         "size": 40

                                                       }, {

                                                                         "status": "in-use",

                                                                         "is_bootable": false,

                                                                         "name": "ghy-3-volume-001",

                                                                         "id": "41703f2d-4672-4445-93e1-e4f158c787e1",

                                                                         "type": "SATA-public",

                                                                         "is_expired": false,

                                                                         "is_encrypted": false,

                                                                         "size": 5

}],

                                                       "nicList": [{

                                                                         "IPv4Address": "192.168.0.94",

                                                                         "isMaster": true,

                                                                         "nicID": "port-durisxbn78",

                                                                         "IPv6Address": null,

                                                                         "subnetCidr": "192.168.0.0/24",

                                                                         "subnetID": "subnet-ty87lkna06",

                                                                         "gateway": "192.168.0.1",

                                                                         "securityGroup": ["sg-767voa4wxg"]

}]

}]

},

                  "message": "SUCCESS",

                  "description": "Successful",

                  "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
Openapi.PatternCheck.NotValid	The request parameter is invalid.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
Ecs.Instance.NotFound	The cloud server is not found. Check whether the cloud server ID is correct.
Openapi.EcsWorkorder.AccessFailed	Internal error. Please try again. If the failure keeps happening, please submit a ticket.

Cloud Server Backup Service

Query a Cloud Server based on a CSBS Backup