Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Schemas/ Querying Details About a Shard Configuration Task (a V3 API)
Updated on 2026-05-30 GMT+08:00
View PDF
Share

Querying Details About a Shard Configuration Task (a V3 API)

Function

This API is used to query details about a shard configuration task.

URI

GET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

instance_id

Yes

String

DDM instance ID

db_name

Yes

String

Schema name

job_id

Yes

String

Workflow ID For details about how to obtain the value of this parameter, see Configuring Shards (a V3 API).

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_name

String

Instance name

original_shard_num

Integer

Total number of shards before configuration

after_shard_num

Integer

Total number of shards after configuration

original_dn_info_list

Array of MigrateDnInfoOpenResponse objects

Information about data nodes before configuration

after_dn_info_list

Array of MigrateDnInfoOpenResponse objects

Information about data nodes after configuration

switch_route_is_manual

Boolean

Whether manual route switching is used.

  • true: Manual route switching is used.
  • false: Automatic route switching is used.

auto_switch_begin_time

String

Time when the automatic route switching starts (in the hh:mm:ss format, for example, 17:00:00)

auto_switch_end_time

String

Time when the automatic route switching ends (in the hh:mm:ss format, for example, 18:00:00)

node_id_for_migrate

String

Node where shard configuration is performed

is_exclusive

Boolean

Whether shard configuration exclusively occupies a node. The value can be:

  • true: It exclusively occupies a node.
  • false: It does not exclusively occupy a node.
Table 4 MigrateDnInfoOpenResponse

Parameter

Type

Description

dn_instance_id

String

RDS instance ID

dn_instance_name

String

RDS instance name

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

None

Example Response

Status code: 200 
{
  "instance_name": "UTS-src",
  "original_shard_num": 8,
  "after_shard_num": 9,
  "original_dn_info_list": [
    {
      "dn_instance_id": "7edae0250ebc464897bd92b8d3e8b769in01",
      "dn_instance_name": "UTS-rds-src"
    }
  ],
  "after_dn_info_list": [
    {
      "dn_instance_id": "7edae0250ebc464897bd92b8d3e8b769in01",
      "dn_instance_name": "UTS-rds-src"
    }
  ],
  "switch_route_is_manual": true,
  "auto_switch_begin_time": "",
  "auto_switch_end_time": "",
  "node_id_for_migrate": "0c12161a26a4426c9bc72efe4ff05224no09",
  "is_exclusive": false
}

Status code: 400

Bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status code: 500

Server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status Codes

Status Codes

Description

200

OK

400

Bad request

500

Server error

Error Codes

For details, see Error Codes.

Parent topic: Schemas