Querying Instances by Engine Version

Function

This API is used to query instances by engine version. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/datastore/instances

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
limit	No	Integer	Definition Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed. Constraints The value cannot be a negative number. Range [1, 100] Default Value 100
offset	No	Integer	Definition Index offset. For example, if this parameter is set to 1 and limit is set to 10, only the 2nd to 11th records are displayed. Constraints The value cannot be negative. Range N/A Default Value 0: The query starts from the first data record.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn: Chinese en-us: English Default Value en-us

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
engine_instance_details	Array of Table 3 InstanceEngineDetail objects	Definition Instance engine details.
total_count	Integer	Definition Total number of engine versions. Range N/A

**Table 4** InstanceEngineDetail description
Parameter	Type	Description
engine_version	String	Definition Engine version. Range N/A
instances	Array of Table 4 InstanceDetail objects	Definition Instance details.

**Table 5** InstanceDetail description
Parameter	Type	Description
instance_id	String	Definition Instance ID. Range N/A
instance_name	String	Definition Instance name. Range N/A
status	String	Definition Instance status. Range BUILD: The instance is being created. BUILD_FAILED: The instance failed to be created. ACTIVE: The instance is normal. FAILED: The instance is abnormal. FROZEN: The instance is frozen. MODIFYING: The storage is being scaled up, or instance specifications are being changed. EXPANDING: Read replicas, CNs, or DN shards are being added to the instance. REBOOTING: The instance is being rebooted. REDUCING: Read replicas are being deleted. UPGRADING: The instance is being upgraded. RESTORING: The instance is being restored. SWITCHOVER: A primary/standby switchover is being performed. MIGRATING: The instance is being migrated. BACKING UP: The instance is being backed up. UPGRADE TO BE OBSERVED: The instance upgrade is in the observation period. MODIFYING DATABASE PORT: The database port is being changed. STORAGE FULL: The instance storage is full. REPAIRING: The instance is being repaired. SHUTDOWN: The instance is stopped.
type	String	Definition Instance type. Range enterprise: distributed centralization_standard: centralized
solution	String	Definition Instance deployment model. Range Ha: centralized deployment Independent: independent deployment Combined: combined deployment
hotfix_versions	String	Definition Updated hot patch version. Range N/A

Example Request

Querying instances by engine versions

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/datastore/instances

Example Response

Instances by engine version queried.

{
    "engine_instance_details": [
        {
            "engine_version": "V2.0-3.220.0",
            "instances": [
                {
                    "status": "ACTIVE",
                    "type": "centralization_standard",
                    "solution": "Ha",
                    "instance_id": "0fd6cb8f0ffe4bba9e98af6f4b403ae8in14",
                    "instance_name": "gauss-472e",
                    "hotfix_versions": ""
                },
                {
                    "status": "ACTIVE",
                    "type": "centralization_standard",
                    "solution": "Ha",
                    "instance_id": "1b5022523d1749abbf2c7a1307cf4378in14",
                    "instance_name": "gauss-2ea0",
                    "hotfix_versions": "3.220.0.11"
                },
                {
                    "status": "ACTIVE",
                    "type": "centralization_standard",
                    "solution": "Ha",
                    "instance_id": "da46dcee6c414a2eae89203804103981in14",
                    "instance_name": "gauss-515d",
                    "hotfix_versions": "3.220.0.11"
                }
            ]
        },
        {
            "engine_version": "V2.0-8.102.0",
            "instances": [
                {
                    "status": "ACTIVE",
                    "type": "enterprise",
                    "solution": "Independent",
                    "instance_id": "a731423300c14a8c866b2f96243ee9cbin14",
                    "instance_name": "gauss-c704",
                    "hotfix_versions": ""
                }
            ]
        }
    ],
    "total_count": 2
}