doc-exports/docs/ddm/api-ref/en-us_topic_0000002298790204.html

Clearing Shard Configuration Data (a V3 API)

Function

This API is used to clear shard configuration data.

Constraints

Only data of shard configuration tasks in the ToBeCleaned state can be cleared.

URI

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

Table 1 Path parameters

Parameter	Type	Mandatory	Description
project_id	String	Yes	Project ID of a tenant in a region
instance_id	String	Yes	Instance ID
db_name	String	Yes	Schema name
job_id	String	Yes	ID of the shard configuration task

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by calling the IAM API used to obtain a user token.

Example Request

Clearing shard configuration data

PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/clean

Response

• Normal response

  Table 3 Response body parameters

  Parameter	Type	Description
  job_id	String	ID of the task for clearing shard configuration data

• Normal response example

  {
    "job_id":"xxxxxxxx-5d7e-4e1a-aeb4-9b1e6d0a4999"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Codes

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Schemas