Function

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

Constraints

None

URI

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

**Table 1** Path parameters
Parameter	Type	Mandatory	Description
project_id	String	Yes	Project ID of a tenant in a region
instance_id	String	Yes	DDM instance ID

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

Exporting schema metadata
GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/schema-metadata

Response

Normal response

**Table 3** Response body parameters
Parameter	Type	Description
compressed_databases_info	String	Distribution information of physical shards in a schema. This information is compressed and encoded.
data_nodes	Array of DNInstanceInfo objects	Information about data nodes

**Table 4** DNInstanceInfo
Parameter	Type	Description
instance_id	String	Data node ID
instance_name	String	Data node name
access_host	String	Access address
access_port	Integer	Access port
engine	String	Engine type
engine_version	String	Engine version

Normal response example

{
	"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"
	}]
}

Abnormal response
For details, see Abnormal Request Results.

Status Codes

Normal
200
Abnormal
For details, see Status Codes.

Error Codes

For details, see Error Codes.

Exporting Schema Metadata (a V3 API)