# 查询实例引擎版本分布 - QueryingInstancesbyEngineVersion #### 功能介绍 查询实例引擎版本分布。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListInstanceEngineDetail)中调试该接口。 #### URI GET /v3/{*project_id*}/datastore/instances 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不能为负数。 **取值范围：** \[1, 100\] **默认取值** **：** 100 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。例如：该参数指定为1，limit指定为10，则只展示第2-11条数据。 **约束限制：** 不能为负数。 **取值范围：** 不涉及。 **默认取值** **：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | engine_instance_details | Array of [表3 InstanceEngineDetail说明] objects | **参数解释：** 实例引擎详情。 | | total_count | integer | **参数解释：** 引擎版本总数，单位：个。 **取值范围：** 不涉及。 | 表4InstanceEngineDetail说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | engine_version | String | **参数解释：** 引擎版本号。 **取值范围：** 不涉及。 | | instances | Array of [表4 InstanceDetail说明] objects | **参数解释：** 实例详情。 | 表5InstanceDetail说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 实例状态。 **取值范围：** - 值为"BUILD"，表示实例正在创建。 - 值为"BUILD_FAILED"，表示实例创建失败。 - 值为"ACTIVE"，表示实例正常。 - 值为"FAILED"，表示实例异常。 - 值为"FROZEN"，表示实例冻结。 - 值为"MODIFYING"，表示实例正在扩容磁盘或者变更规格。 - 值为"EXPANDING"，表示实例正在添加只读节点或扩容CN或DN。 - 值为"REBOOTING"，表示实例正在重启。 - 值为"REDUCING", 表示实例正在删除只读节点。 - 值为"UPGRADING"，表示实例正在升级。 - 值为"RESTORING"，表示实例正在恢复。 - 值为"SWITCHOVER"，表示实例正在主备切换。 - 值为"MIGRATING"，表示实例正在迁移。 - 值为"BACKING UP"，表示实例正在进行备份。 - 值为"UPGRADE TO BE OBSERVED"，表示实例正在进行升级待观察。 - 值为"MODIFYING DATABASE PORT"，表示实例正在修改数据库端口。 - 值为"STORAGE FULL"，表示实例磁盘空间满。 - 值为"REPAIRING"，表示实例正在修复。 - 值为"SHUTDOWN"，表示实例已停止。 | | type | String | **参数解释：** 实例类型。 **取值范围：** - **enterprise：**分布式版 - **centralization_standard**：集中式版 | | solution | String | **参数解释：** 实例部署形态。 **取值范围：** - Ha：集中式版。 - Independent：独立部署。 - Combined：混合部署。 | | hotfix_versions | String | **参数解释：** 已升级热补丁版本。 **取值范围：** 不涉及。 | #### 请求示例 查询实例引擎版本分布。 ``` GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/datastore/instances ``` #### 响应示例 查询实例引擎版本分布成功。 ``` { "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 } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。