Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Data Migration (RDS for PostgreSQL)/ Querying Ongoing DRS Synchronization Tasks of an Instance
Updated on 2026-07-21 GMT+08:00
View PDF
Share

Querying Ongoing DRS Synchronization Tasks of an Instance

Function

This API is used to query ongoing DRS synchronization tasks of an instance. This API can only be used to query DRS synchronization tasks created on the RDS console.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:listDrsJob

-

instance

-

-

-

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/drs-job/name

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

None

Example Request

Query ongoing DRS synchronization tasks of an instance. 
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/42d4b4fc17d144bbb3ba64a306e68c72in03/drs-job/name

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    drs_name

    string

    Definition

    DRS synchronization task name.

    Range

    N/A
  • Example normal response 
    {
   "drs_name": "PostgreSQL-42d4b4fc17d144bbb3ba64a306e68c72"
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.