Querying RPO and RTO in Batches

Function

This API is used to batch query Recovery Point Objective (RPO) and Recovery Time Objective (RTO).

Debugging

You can debug the API in API Explorer to support automatic authentication. API Explorer can automatically generate and debug example SDK code.

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 and Supported Actions.

URI

POST /v3/{project_id}/jobs/batch-rpo-and-rto

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. Constraints N/A Range application/json Default Value application/json
X-Auth-Token	Yes	String	Definition User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
jobs	Yes	Array of strings	Definition Task IDs for querying RPO and RTO in batches. This parameter is used to specify one or more tasks to be queried. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Definition Total number of returned RPO and RTO query results, which is consistent with the length of the results array. Constraints N/A Range N/A
results	Array of objects	Definition Response body set for querying RPO and RTO in batches. Each element contains the RPO and RTO information of a task. For details, see Table 5.

**Table 5** Data structure description of field **results**
Parameter	Type	Description
job_id	String	Definition Data replication task ID, which uniquely identifies a task. Constraints N/A Range N/A
rpo_info	Object	Definition RPO information, which indicates the latest time to which data can be restored in a DR task. For details, see Table 6.
rto_info	Object	Definition RTO information, which indicates the maximum duration required for service recovery in a DR task. For details, see Table 6.
error_code	String	Definition Error code returned if querying RTO and RPO fails. Constraints N/A Range The value is in the format of DRS.XXXXXX.
error_msg	String	Definition Error message returned if querying RTO and RPO fails. Constraints N/A Range N/A

**Table 6** Data structure description of fields **rpo_info** and **rto_info**
Parameter	Type	Description
check_point	String	Definition Checkpoint position of data replication, which identifies the binlog position of the synchronized data. Constraints N/A Range N/A
delay	String	Definition Data delay, in ms. Constraints N/A Range N/A
gtid_set	String	Definition Global transaction identifier (GTID) set, which identifies executed transactions. Constraints N/A Range N/A
time	String	Definition Statistical time point for RPO or RTO, in the format of yyyy-MM-dd HH:mm:ss. Constraints N/A Range N/A

Example Request

Example of querying RPO and RTO in batches:

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-rpo-and-rto

{
  "jobs" : [ "8d0e8e36-a618-490d-8a46-8c61ac9jb502" ]
}

Example Response

Status code: 202

Accepted

{
  "count" : 1,
  "results" : [ {
    "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
    "rpo_info" : {
      "delay" : "0",
      "time" : "2020-12-18 15:47:05",
      "gtid_set" : "NA",
      "check_point" : "mysql-bin.000514:197"
    },
    "rto_info" : {
      "delay" : "0",
      "time" : "2020-12-18 15:47:05",
      "gtid_set" : "NA",
      "check_point" : "mysql-bin.000514:197"
    }
  } ]
}

Status Code

Status Code	Description
202	Accepted
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Real-Time Disaster Recovery

Previous topic: Real-Time Disaster Recovery

Next topic: APIs V5.0