Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Schemas/ Exporting Schema Metadata (a V3 API)
Updated on 2026-06-05 GMT+08:00
View PDF
Share

Exporting Schema Metadata (a V3 API)

Function

This API is used to export all schema metadata about distribution of physical shards on data nodes.

URI

GET /v3/{project_id}/instances/{instance_id}/schema-metadata

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

DDM instance ID

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

compressed_databases_info

String

Schema information

data_nodes

Array of DnInstanceInfo objects

Information about associated backend data nodes
Table 4 DnInstanceInfo

Parameter

Type

Description

instance_id

String

ID of the backend data node

instance_name

String

Name of the backend data node

access_host

String

IP address of the backend data node

access_port

Integer

Port of the backend data node

engine

String

Engine of the backend data node

engine_version

String

Engine version of the backend data node

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

Exporting schema metadata
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/schema-metadata

Example Response

Status code: 200 
{
	"compressed_databases_info": "H4sIAAAAAAAAAN3cTW/bRhgE4P/Csw7aL4rUtQUKX3wo0lMQCPxYNQJsOjApIIWR/17K1RvDPgQ9...",
	"data_nodes": [{
		"instance_id": "91b1272b09364ddeb999f1295bf0506ain01",
		"instance_name": "rds-for-ddm-01",
		"access_host": "172.16.192.110",
		"access_port": 3306,
		"engine": "mysql",
		"engine_version": "5.7"
	}]
}

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