Querying Schemas¶

Function¶

This API is used to query schemas of a DDM instance.

Constraints¶

None

URI¶

GET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
instance_id	Yes	String	DDM instance ID

**Table 2** Query parameters¶
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. The query starts from the next piece of data indexed by this parameter. The value is 0 by default. The value must be a positive integer.
limit	No	Integer	Maximum schemas to be queried. Value range: 1 to 128. If the parameter value is not specified, 10 schemas are queried by default.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
databases	Array of GetDatabaseInfo objects	Schema information
total	Integer	Total records

**Table 5** GetDatabaseInfo¶
Parameter	Type	Description
name	String	Schema name
shard_mode	String	Sharding mode of the schema cluster: indicates that the schema is in sharded mode. single: indicates that the schema is in unsharded mode.
shard_number	Integer	Number of shards in the same working mode
status	String	Schema status. For details about this parameter value, see Status Description.
created	Integer	Time when the schema is created
used_rds	Array of GetDatabaseUsedRds objects	RDS instances associated with the schema
shard_unit	Integer	Number of shards per RDS instance

**Table 6** GetDatabaseUsedRds¶
Parameter	Type	Description
id	String	Node ID of the associated RDS instance
name	String	Name of the associated RDS instance
status	String	Status of the associated RDS instance
error_msg	String	Response message. This parameter is not returned if no abnormality occurs.

Status code: 400

**Table 7** Response body parameters¶
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

Status code: 500

**Table 8** Response body parameters¶
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

Example Request¶

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}

Example Response¶

Status code: 200

{
    "databases": [{
        "status": "RUNNING",
        "created": 1642063713625,
        "name": "mytestdb170",
        "shard_mode": "cluster",
        "shard_number": 8,
        "shard_unit": 8,
        "used_rds": [{
            "id": "c6f68fed9e74478c8679479a07d7d568in01",
            "status": "normal",
            "name": "rds-test"
        }]
    }],
    "total": 172
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes¶

Status Code	Description
200	OK
400	bad request
500	server error

Error Codes¶

For details, see Error Codes.

last updated: 2024-12-11 13:43 UTC - commit: 0e04c4a111cf440cbe530f17da84f5c1ac074d8f