查询HTAP实例列表
URI
GET /v3/{project_id}/instances/{instance_id}/htap
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
|
instance_id |
是 |
String |
GaussDB(for MySQL)实例ID，严格匹配UUID规则。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
Content-Type |
是 |
String |
内容类型。 取值：application/json。 |
|
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围：
|
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
HTAP实例个数。 |
|
instances |
Array of instances objects |
HTAP实例信息。 |
|
max_htap_instance_num_of_taurus |
Integer |
最大HTAP实例个数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
HTAP实例ID，严格匹配UUID规则。 |
|
name |
String |
HTAP实例名。 |
|
engine_name |
String |
HTAP数据库引擎名。 |
|
engine_version |
String |
HTAP数据库引擎版本。 |
|
project_id |
String |
租户在某一region下的project ID。 |
|
instance_state |
instance_state object |
HTAP实例状态信息。 |
|
create_at |
Long |
HTAP实例创建时间。 |
|
is_frozen |
Boolean |
HTAP实例是否冻结。 |
|
ha_mode |
String |
HTAP实例部署模式。 |
|
pay_model |
String |
计费模式。当前仅支持按需计费。
|
|
order_id |
String |
包周期计费订单ID。 |
|
alter_order_id |
String |
包周期计费备用订单ID。 |
|
data_vip |
String |
读写内网地址。 |
|
readable_node_infos |
Array of ReadableNodeInfos objects |
可读节点信息。 |
|
proxy_ips |
Array of strings |
代理IP。 |
|
data_vip_v6 |
String |
读写内网地址IPV6。 |
|
port |
Integer |
数据库访问端口。 |
|
available_zones |
Array of available_zones objects |
可用区信息。 |
|
current_actions |
Array of QueryAction objects |
实例动作。 |
|
volume_type |
String |
存储类型。 |
|
server_type |
String |
服务器类型。 |
|
enterprise_project_id |
String |
企业项目ID。如果帐户开通企业项目服务则该参数必选，未开启该参数不可选。 |
|
dedicated_resource_id |
String |
专属资源池ID，只有开通专属资源池后才支持此参数。 |
|
network |
network object |
网络信息。 |
|
ch_master_node_id |
String |
ClickHouse主节点ID。 |
|
node_num |
Integer |
节点个数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_status |
String |
HTAP实例状态。 |
|
create_fail_error_code |
String |
HTAP实例创建失败错误码。 |
|
fail_message |
String |
HTAP实例创建失败错误信息。 |
|
wait_restart_for_params |
Boolean |
是否需要重启更新参数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_ip |
String |
可读节点IP。 |
|
node_id |
String |
可读节点ID。 |
|
node_name |
String |
可读节点名称。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
实例或节点动作ID。 |
|
action |
String |
实例或节点动作名称。 |
|
object_id |
String |
实例或节点动作对象ID。 |
|
type |
String |
实例或节点动作类型。 |
|
job_id |
String |
实例或节点动作任务ID。 |
|
status |
String |
实例或节点动作状态。 枚举值：
|
|
created_at |
Long |
实例或节点动作创建时间。 |
|
updated_at |
Long |
实例或节点动作更新时间。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vpc_id |
String |
虚拟私有云ID。 |
|
sub_net_id |
String |
子网ID。 |
|
security_group_id |
String |
安全组ID。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
请求示例
查询GaussDBforMySQL下HTAP实例列表
GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/18c3eeb7b788479eb8b93b209946a83bin07/htap
响应示例
状态码： 200
Success.
{
"total" : 4,
"instances" : [ {
"id" : "bfc970d8e9b34a399b4c422aabe11409in17",
"name" : "htap-fjld",
"engine_name" : "star-rocks",
"engine_version" : "3.1.6",
"project_id" : "23a50154cf494ec9ad6883979a12db0a",
"instance_state" : {
"instance_status" : "normal",
"create_fail_error_code" : null,
"fail_message" : null,
"wait_restart_for_params" : false
},
"create_at" : 1711094408228,
"is_frozen" : false,
"ha_mode" : "Single",
"pay_model" : "0",
"order_id" : null,
"alter_order_id" : "",
"data_vip" : "192.168.0.207",
"data_ips" : {
"node_ip" : "192.168.0.207",
"node_id" : "36d62cd6a77a4e80a335077867e7912bno16",
"node_name" : "htap-1244_shard01_node01"
},
"proxy_ips" : [ ],
"data_vip_v6" : null,
"port" : 3306,
"available_zones" : [ {
"code" : "cn-southwest-244b",
"description" : "az2",
"az_type" : "Center"
} ],
"current_actions" : [ ],
"volume_type" : "SSD",
"server_type" : "KVM",
"enter_prise_project_id" : "0",
"dedicated_resource_id" : "",
"network" : {
"vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
"sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
"security_group_id" : ""
},
"ch_master_node_id" : null,
"node_num" : 2
}, {
"id" : "656c539296bd47b49fe29983368b9fb2in17",
"name" : "HTAP-1711093893",
"engine_name" : "star-rocks",
"engine_version" : "3.1.6",
"project_id" : "23a50154cf494ec9ad6883979a12db0a",
"instance_state" : {
"instance_status" : "normal",
"create_fail_error_code" : null,
"fail_message" : null,
"wait_restart_for_params" : false
},
"create_at" : 1711094228737,
"is_frozen" : false,
"ha_mode" : "Single",
"pay_model" : "0",
"order_id" : null,
"alter_order_id" : "",
"data_vip" : "192.168.0.201",
"data_ips" : [ "192.168.0.201" ],
"proxy_ips" : [ ],
"data_vip_v6" : null,
"port" : 3306,
"available_zones" : [ {
"code" : "az",
"description" : "az2",
"az_type" : "Center"
} ],
"current_actions" : [ ],
"volume_type" : "SSD",
"server_type" : "KVM",
"enter_prise_project_id" : "0",
"dedicated_resource_id" : "",
"network" : {
"vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
"sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
"security_group_id" : ""
},
"ch_master_node_id" : null,
"node_num" : 2
}, {
"id" : "04c48d11f0d24c8d8aee254981a3b94fin17",
"name" : "htap-fjlc",
"engine_name" : "star-rocks",
"engine_version" : "3.1.6",
"project_id" : "23a50154cf494ec9ad6883979a12db0a",
"instance_state" : {
"instance_status" : "normal",
"create_fail_error_code" : null,
"fail_message" : null,
"wait_restart_for_params" : false
},
"create_at" : 1711075260516,
"is_frozen" : false,
"ha_mode" : "Cluster",
"pay_model" : "0",
"order_id" : null,
"alter_order_id" : "",
"data_vip" : "192.168.0.249",
"data_ips" : [ "192.168.0.183", "192.168.0.7", "192.168.0.41" ],
"proxy_ips" : [ ],
"data_vip_v6" : null,
"port" : 3306,
"available_zones" : [ {
"code" : "az",
"description" : "az2",
"az_type" : "Center"
} ],
"current_actions" : [ ],
"volume_type" : "SSD",
"server_type" : "KVM",
"enter_prise_project_id" : "0",
"dedicated_resource_id" : "",
"network" : {
"vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
"sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
"security_group_id" : ""
},
"ch_master_node_id" : null,
"node_num" : 6
}, {
"id" : "f2d2441a88384023b2e30f0b600a0013in17",
"name" : "htap-fjlb",
"engine_name" : "star-rocks",
"engine_version" : "3.1.6",
"project_id" : "23a50154cf494ec9ad6883979a12db0a",
"instance_state" : {
"instance_status" : "normal",
"create_fail_error_code" : null,
"fail_message" : null,
"wait_restart_for_params" : false
},
"create_at" : 1711021269903,
"is_frozen" : false,
"ha_mode" : "Single",
"pay_model" : "0",
"order_id" : null,
"alter_order_id" : "",
"data_vip" : "192.168.0.209",
"data_ips" : [ "192.168.0.151", "192.168.0.209" ],
"proxy_ips" : [ ],
"data_vip_v6" : null,
"port" : 3306,
"available_zones" : [ {
"code" : "cn-southwest-244b",
"description" : "az2",
"az_type" : "Center"
} ],
"current_actions" : [ ],
"volume_type" : "SSD",
"server_type" : "KVM",
"enter_prise_project_id" : "0",
"dedicated_resource_id" : "",
"network" : {
"vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
"sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
"security_group_id" : ""
},
"ch_master_node_id" : null,
"node_num" : 2
} ],
"max_htap_instance_num_of_taurus" : 10
}
状态码
请参见状态码。
错误码
请参见错误码。
