# 查询指定实例 #### 功能介绍 通过实例ID查询实例的详细信息。 #### **URI** GET /v1.0/{project_id}/instances/{instance_id} 参数说明见[表1]。 表1参数说明 | 参数 | 类型 | 必选 | 说明 | |:---|:---|:---|:---| | project_id | String | 是 | 获取方式，参考[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 | | instance_id | String | 是 | 待查询的实例ID。 | #### **请求消息** **请求参数** 无。 **请求示例** 请求URL： ``` GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id} ``` #### **响应消息** **响应参数** 参数说明见[表2]。 表2参数说明 | 参数 | 类型 | 说明 | |:---|:---|:---| | name | String | 实例名称。 | | engine | String | 缓存实例的引擎类型。 | | capacity | Integer | 缓存实例的容量（G Byte）。 | | ip | String | 连接缓存实例的IP地址。如果是集群实例，返回多个IP地址，使用逗号分隔。如：192.168.0.1，192.168.0.2。 | | domainName | String | 实例的域名。 | | port | Integer | 缓存的端口。 | | status | String | 缓存实例的状态。详细状态说明见[缓存实例状态说明](https://support.huaweicloud.com/api-dcs/dcs-api-0312047.html)。 | | libos | Boolean | - true：该实例是libos实例。 - false：该实例不是libos实例。 | | description | String | 实例描述。 | | max_memory | Integer | 总内存，单位：MB。 | | used_memory | Integer | 已使用的内存，单位：MB。 | | instance_id | String | 实例ID。 | | resource_spec_code | String | 资源规格标识。对应控制台创建缓存实例页面的实例规格名称。 | | engine_version | String | 缓存版本。 | | internal_version | String | DCS内部版本号。 | | charging_mode | Integer | 付费模式，0表示按需计费，1表示包年/包月计费。 | | capacity_minor | String | 单机小规格的缓存容量。 | | vpc_id | String | VPC ID。 | | vpc_name | String | VPC的名称。 | | created_at | String | 完成创建时间。格式为：2017-03-31T12:24:46.297Z | | error_code | String | 实例创建失败或状态异常时的错误码，错误码说明见[表3]。 | | user_id | String | 用户id。 | | user_name | String | 用户名。 | | maintain_begin | String | 维护时间窗开始时间，格式为HH:mm:ss。 | | maintain_end | String | 维护时间窗结束时间，格式为HH:mm:ss。 | | no_password_access | String | 是否允许免密码访问缓存实例。 - true：该实例无需密码即可访问。 - false：该实例必须通过密码认证才能访问。 | | access_user | String | 通过密码认证访问缓存实例的认证用户名。 | | enable_publicip | Boolean | Redis缓存实例是否开启公网访问功能。 - true：开启 - false：不开启 | | publicip_id | String | Redis缓存实例绑定的弹性IP地址的id。 如果未开启公网访问功能，该字段值为null。 | | publicip_address | String | Redis缓存实例绑定的弹性IP地址。 如果未开启公网访问功能，该字段值为null。 | | enable_ssl | Boolean | Redis缓存实例开启公网访问功能时，是否选择支持ssl。 - true：开启 - false：不开启 | | service_upgrade | Boolean | 实例是否存在升级任务。 - true：存在 - false：不存在 | | service_task_id | String | 升级任务的ID。 - 当service_upgrade为true时，该参数为升级任务的ID。 - 当service_upgrade为false时，该参数为空。 | | enterprise_project_id | String | 企业项目ID。 | | available_zones | Array | 实例节点所在的可用区。返回"可用区ID"。 | | subnet_id | String | 子网ID。 | | security_group_id | String | 安全组ID。 | | backend_addrs | String | 集群实例的后端服务地址。 | | product_id | String | 产品标识。 | | security_group_name | String | 租户安全组名称。 | | subnet_name | String | 子网名称。 | | subnet_cidr | String | 子网网段。 | | order_id | String | 订单ID。 | | instance_backup_policy | JSON | 备份策略，实例类型为主备和集群时支持。详情参考[表4](https://support.huaweicloud.com/api-dcs/dcs-api-0312004.html#dcs-api-0312004__table12803218151513)和[表5](https://support.huaweicloud.com/api-dcs/dcs-api-0312004.html#dcs-api-0312004__table187492037201518)。 | | tags | Array of objects | 实例标签键值。 | 表3错误码说明 | 错误码 | 说明 | |:---|:---| | dcs.00.0007 | 系统异常。 | | dcs.01.0001 | 内部服务错误。 | | dcs.01.0002 | 内部服务错误。 | | dcs.01.0003 | 内部服务错误。 | | dcs.02.0001 | VPC创建失败。 | | dcs.02.0002 | VPC创建失败。 | | dcs.02.0003 | 安全组创建失败。 | | dcs.02.0004 | 子网创建失败。 | | dcs.02.0005 | 子网状态异常。 | | dcs.03.0001 | 创建ECS失败。 | | dcs.03.0002 | 创建ECS失败。 | | dcs.03.0003 | 创建ECS失败。 | | dcs.03.0004 | 创建ECS失败。 | | dcs.03.0005 | ECS绑定网卡失败。 | | dcs.03.0007 | ECS启动失败。 | | dcs.03.0008 | ECS启动失败。 | | dcs.03.0009 | ECS停止失败。 | | dcs.03.0017 | 实例部分节点故障。 | | dcs.04.0002 | 实例部署异常。 | | dcs.04.0003 | 无法连接实例。 | | dcs.04.0004 | 存在两个主节点，主备节点间网络连接可能有问题。 | **响应示例** ``` { "name": "dcs-125d", "engine": "Redis", "capacity": 64, "ip": "192.168.1.48", "domainName": "XXXXXX", "port": 6379, "status": "RUNNING", "libos": false, "description": null, "task": null, "max_memory": 65536, "used_memory": 33, "instance_id": "979e9a6b-e2f5-4b5d-8e98-fea495ea27a1", "resource_spec_code": "dcs.cluster", "engine_version": "3.0", "internal_version": null, "charging_mode": 0, "capacity_minor": null, "vpc_id": "d1e8008d-8182-4c86-a142-1ae9349bdc64", "vpc_name": "vpc-807d", "task_status": null, "created_at": "2018-12-11T07:24:18.149Z", "error_code": null, "user_id": "9bfac09d9bcd4eb7bb1465a7bcff815b", "user_name": "r00209145", "maintain_begin": "02:00:00", "maintain_end": "06:00:00", "no_password_access": "true", "access_user": null, "enable_publicip": false, "publicip_id": null, "publicip_address": null, "enable_ssl": false, "service_upgrade": false, "service_task_id": null, "is_free": null, "enterprise_project_id": "0", "available_zones": ["f84448fd537f46078dd8bd776747f573"], "subnet_id": "9b32218f-6389-485a-912e-076fe9df6fa7", "security_group_id": "ecefdad9-c8be-42aa-9d5d-9ab46a221240", "backend_addrs": ["192.168.1.136:6379", "192.168.1.224:6379"], "product_id": "00301-17063-0--0", "security_group_name": "sg--test-hanwang", "subnet_name": "subnet-7e46", "order_id": null, "subnet_cidr": "192.168.1.0/24", "instance_backup_policy": null, "tags": [ { "key": "dcs001", "value": "001" }, { "key": "dcs002", "value": "002" } ], "enterprise_project_name": null } ``` #### **状态码** 操作成功的状态码如[表4]所示，其他响应见[表1](https://support.huaweicloud.com/api-dcs/dcs-api-0312043.html#dcs-api-0312043__table5210141351517)。 表4状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询指定实例成功。 |