API Introduction

Query the information of a CSBS backup policy based on the policy ID, especially the bound cloud server.

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 backup policy must be an existing one.

URI

<span lang="EN-US">GET /v4/ecs/backup-policy/list-instances</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 refer toRegions and Availability Zonesto learn more about resource pools. More APIs:QuerytheResource Pool List.	bb9fdb42056f11eda1610242ac110002
policyID	Yes	String	Backup policy ID, in 32-bit. More APIs:QuerytheCSBS Backup Policy ListandCreate a CSBS Backup Policy.	26da64d4a77f11ed923d0242ac110007
instanceName	No	String	Cloud server name. Fuzzy filter.	ecm-888
pageNo	No	Integer	Page number. Value range: Positive integer (≥1). Default value: 1.	1
pageSize	No	Integer	Number of records on each page. Value range: [1, 50]. Default value: 10.	10

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 descripting in English.	SUCCESS
description	String	Error description in Chinese.	Successful
returnObj	Object	Return object.		returnObj

Table returnObj

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

Table instancePolicies

Parameter	Parameter Type	Description	Example
status	String	Cloud server status.	ACTIVE
attachedVolumes	Array of Strings	List of EVS disk IDs of the cloud server.	["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"]
displayName	String	The name of the cloud server displayed.	ecm-6666
instanceID	String	Cloud server ID.	142dcec0-31c4-1f50-708a-43a7edb94a52
regionID	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
instanceName	String	Cloud Server Name	ecm-8888
createTime	String	Created At	2023-01-29T07:28:44Z
updateTime	String	Update At	2023-01-29T07:28:44Z

Sample Request

Request URL

Example: Query information of the cloud server bound with the backup policy

`GET .../openapi/v4/ecs/backup-policy/list-instances?policyID=26da64d4a77f11ed923d0242ac110007&regionID=bb9fdb42056f11eda1610242ac110002`

Request Header

None

Request Body

None

Response Example

    "returnObj": {

        "totalCount": 2,

        "totalPage": 1,

        "instancePolicies": [

                "status": "SHUTOFF",

                "attachedVolumes": [

                    "7741c83b-6d34-402a-a225-3895813254cf",

                    "6dba6d18-b5f3-479f-b520-6f11a1d8bea6"

],

                "displayName": "api-New-0003",

                "instanceID": "ab12cf45ad",

                "regionID": "81f7728662dd11ec810800155d307d5b",

                "instanceName": "api-batchnew-0003",

                "createTime": "2023-01-29T07:28:44Z",

                "updateTime": "2023-01-29T07:28:44Z"

},

                "status": "ACTIVE",

                "attachedVolumes": [

                    "e734bfa7-3eb3-45ac-8109-187de80d48c0",

                    "35bcbcf3-c2fe-4c6e-be28-1f97f723ebd9"

],

                "displayName": "new-test-0002",

                "instanceID": "142dcec0-31c4-1f50-708a-43a7edb94a52",

                "regionID": "ab12cf45ad",

                "instanceName": "new-test-0002",

                "createTime": "2023-01-29T07:28:44Z",

                "updateTime": "2023-01-29T07:28:44Z"

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EcsBackup.RegionInfo.AccessFailed	Failed to query the resource pool.
Ecsbackup.Parameter.InvalidRegionID	The request parameter is invalid.
EcsBackup.PolicyCheck.PolicyIdNotUUIDFormat	The ID of the backup policy must be in UUID format.
EcsBackup.PolicyCheck.NotFound	The backup policy is not found.
Openapi.PatternCheck.NotValid	The request parameter is invalid.
EcsBackup.Admin.AccessFailed	System error.

Cloud Server Backup Service