API Introduction

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

Preparations :

Construct a request: Before you call an API, you must learn how to construct a request. For details, see Construct a Request.

Authentication: OpenAPI requests need to be encrypted. For details, see Authentication.

API Restrictions

1. 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 (Central Enterprises), East 1, Shanghai 32, Shanghai 33, and Shanghai 36.

2. The cloud server must be an existing one.

URI

<span lang="EN-US">GET /v4/ecs/backup/instance-details</span>

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example	Lower-level Object
regionID	Yes	String	Resource pool ID. You can refer toRegions and Availability Zonesto learn more about resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
instanceID	Yes	String	Cloud server ID. You can refer toECSto learn more about cloud servers. More APIs:Query the Cloud Server List.	69aac66c-78e8-e704-e6e1-311b3f40a278

Request Parameters

Request Header Parameter

None

Request Body Parameter

None

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.	Openapi.PatternCheck.NotValid
message	String	Error description upon a failure, usually in English.	SUCCESS
description	String	Error description upon a failure, usually in Chinese.	Successful
returnObj	Object	Response Parameters		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example	Lower-level Object
projectID	String	Enterprise project ID.	0
azName	String	Availability zone name.	cn-huadong1-jsnj1A-public-ctcloud
attachedVolume	Array of Strings	EVS disk ID list.	["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"]
addresses	Array of Objects	IP address information.		addresses
resourceID	String	Resource ID	f88bc88a88a888e8a88bf88888888888
instanceID	String	Cloud server ID.	88f888ea-88ff-88ec-a8bc-888888888fe8
displayName	String	The name of the cloud server displayed.	xxx-8888
instanceName	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
instanceStatus	String	Cloud server status. Value range: backingup, creating, expired, freezing, rebuild, restarting, running, starting, stopped, stopping, error, and snapshotting .	running
expiredTime	String	Expiration Time	2023-04-19T09:37:53Z
availableDay	Integer	Available time (Day).	10
updatedTime	String	Update At	2022-10-19T09:37:53Z
createdTime	String	Created At	2022-10-19T09:37:53Z
zabbixName	String	Name of monitored object.	8a8fdc88-b8a8-88bb-888f-8b88888c88f8
secGroupList	Array of Objects	Security group info.		secGroupList
privateIP	String	Intranet IPv4 Address	10.0.0.1
privateIPv6	String	Intranet IPv6 address.	888:8:8c8:8888:bee8:88d8:c8a8:888
networkCardList	Array of Objects	ENI info.		networkCardList
vipInfoList	Array of Objects	Virtual IP (VIP) info list.		vipInfoList
vipCount	Integer	VIP quantity.	1
affinityGroup	Object	Cloud server group info.		affinityGroup
image	Object	Image info.		image
flavor	Object	Cloud server specifications.		flavor
onDemand	Boolean	Payment method. Value range: false: subscription-based. true: pay-as-you-go.	true
vpcName	String	VPC name.	vpc-xxx
vpcID	String	vpc ID	vpc-xxx8xxxxxx
fixedIP	Array of Strings	Intranet IP	["10.0.0.1"]
floatingIP	String	Public IP
subnetIDList	Array of Strings	Subnet ID list.	["subnet-0yy0yy0yyy"]
keypairName	String	Key pair name.	keypair-name1
volumes	Array of Objects	EVS Info		volumes

Table addresses

Parameter	Parameter Type	Description	Example	Lower-level Object
vpcName	String	VPC name.	vpc-xxxx
addressList	Array of Objects	Network address list.		addressList

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 networkCardList

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 info.	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.	192.168.0.1
networkCardID	String	NIC ID	port-5ttttt9tt8
securityGroup	Array of Strings	Security group ID list.	["sg-xxxxxxxx7x"]

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
flavorName	String	Specification Name	s7.medium.2
flavorCPU	Integer	VCPU	1
flavorRAM	Integer	Memory	2048
gpuType	String	GPU type. Value range: T4, V100, V100S, A10, A100, atlas 300i pro, and mlu370-s4. There will be more supported types with the feature upgrades.	T4
gpuCount	Integer	GPU quantity.	1
gpuVendor	String	GPU Name	gpu-x
videoMemSize	Integer	GPU video memory.	2

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 volumes

Parameter	Parameter Type	Description	Example
isBootable	Boolean	Indicate whether this is a startup disk.	true
diskSize	Integer	EVS disk size (GB).	40
diskType	String	EVS disk type. Value range: SATA: ordinary I/O. SAS: high I/O. SSD: ultra-high I/O. SSD-genric: general-purpose SSD. FAST-SSD: express SSD.	SATA
diskID	String	EVS ID	a691c8f9-6010-47d8-9534-d30c19b1a82c
diskName	String	EVS Name	vol-test01

Sample Request

Request URL

Query cloud server information, especially the disk mounting information.

GET '.../v4/ecs/backup/instance-details?regionID=bb9fdb42056f11eda1610242ac110002&instanceID=69aac66c-78e8-e704-e6e1-311b3f40a278'

Request Header

None

Request Body

None

Response Example

                  "returnObj": {

                                     "affinityGroup": null,

                                     "availableDay": 294,

                                     "addresses": [{

                                                       "vpcName": "vpc-6cd0",

                                                       "addressList": [{

                                                                         "addr": "192.168.0.48",

                                                                         "version": 4,

                                                                         "type": "fixed"

}]

}],

                                     "instanceStatus": "running",

                                     "projectID": "0",

                                     "image": {

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

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

},

                                     "secGroupList": [{

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

                                       "securityGroupID": "sg-767voa4wxg"

}],

                                     "vpcName": "vpc-6cd0",

                                     "azName": "cn-huadong1-jsnj1A-public-ctcloud",

                                     "zabbixName": "69aac66c-78e8-e704-e6e1-311b3f40a278",

                                     "osType": 5,

                                     "displayName": "ghy-e338",

                                     "fixedIPList": ["192.168.0.48"],

                                     "networkCardList": [{

                                                       "IPv4Address": "192.168.0.48",

                                                       "IPv6Address": null,

                                                       "isMaster": true,

                                                       "subnetCidr": "192.168.0.0/24",

                                                       "networkCardID": "port-ky542t5wv5",

                                                       "gateway": "192.168.0.1",

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

                                                       "subnetID": "subnet-ty87lkna06"

}],

                                     "flavor": {

                                                       "flavorID": "c5f17f9c-5cfd-9c87-72dd-152171c9002a",

                                                       "flavorName": "s7.medium.2",

                                                       "flavorCPU": 1,

                                                       "flavorRAM": 2048,

                                                       "gpuType": null,

                                                       "gpuCount": null,

                                                       "gpuVendor": null,

                                                       "videoMemSize": null

},

                                     "vipCount": 0,

                                     "keypairName": "keypair-name1",

                                     "updatedTime": "2023-03-10T07:48:30Z",

                                     "vpcID": "vpc-ttxdh00rjf",

                                     "attachedVolume": ["a691c8f9-6010-47d8-9534-d30c19b1a82c", "9a37b2d0-7bbf-4047-be1b-f6cf85187105"],

                                     "onDemand": false,

                                     "floatingIP": null,

                                     "instanceID": "69aac66c-78e8-e704-e6e1-311b3f40a278",

                                     "resourceID": "1c3c5bfac41f45678712e212d84bba06",

                                     "vipInfoList": null,

                                     "privateIP": "192.168.0.48",

                                     "privateIPv6": "",

                                     "expiredTime": null,

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

                                     "volumes": [{

                                                       "diskName": "ecm-e338-volume_000",

                                                       "diskSize": 40,

                                                       "diskType": "SATA-public",

                                                       "diskID": "a691c8f9-6010-47d8-9534-d30c19b1a82c",

                                                       "isBootable": true

                                     }, {

                                                       "diskName": "ecm-e338-volume-001",

                                                       "diskSize": 20,

                                                       "diskType": "SATA-public",

                                                       "diskID": "9a37b2d0-7bbf-4047-be1b-f6cf85187105",

                                                       "isBootable": false

}],

                                     "createdTime": "2023-03-07T06:55:24Z",

                                     "instanceName": "ecm-e338"

},

                  "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.WorkOrder.QueryFail	Failed to query the cloud server based on the CSBS backup.
Ecs.Instance.NotFound	The cloud server is not found. Check whether the cloud server ID is correct.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.

Cloud Server Backup Service

Query the Cloud Server based on a CSBS Backup