本文介绍 Meta Service 提供的所有 API。

API 版本

为了兼容和扩展的需要，未来所有接口实现中均附带明确的版本号，使用时建议附带版本号加以区分。目前，所有已有接口均已添加v1/作为版本标识。

以 create_instance 为例，附带 API 版本的接口为：

1. PUT /MetaService/http/v1/create_instance?token=<token> HTTP/1.1

为了保证兼容性，已有的接口不附带 v1/ 仍能访问。

字段值要求

部分字段的取值范围以及格式要求需要特别注意。

创建存储后端的 Instance

接口描述

本接口用于创建一个 Instance，支持使用一个或多个存储后端（包括 HDFS 和 S3）。该 Instance 不包含任何节点信息，不能多次创建同一个 instance_id 的 Instance。

请求

基于 HDFS 为存储后端的请求

• 创建基于 HDFS 为存储后端的请求语法

1. PUT /MetaService/http/create_instance?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain

5. {
6. "instance_id": string,
7. "name": string,
8. "user_id": string,
9. "vault": {
10. "hdfs_info" : {
11. "build_conf": {
12. "fs_name": string,
13. "user": string,
14. "hdfs_kerberos_keytab": string,
15. "hdfs_kerberos_principal": string,
16. "hdfs_confs" : [
17. {
18. "key": string,
19. "value": string
20. }
21. ]
22. },
23. "prefix": string
24. }
25. }
26. }

• 创建基于 HDFS 为存储后端的请求参数

• 创建基于 HDFS 为存储后端的请求示例

1. PUT /MetaService/http/create_instance?token=greedisgood9999 HTTP/1.1
2. Content-Length: 550
3. Content-Type: text/plain
4. {
5. "instance_id": "sample_instance_id",
6. "name": "sample_instance_name",
7. "user_id": "sample_user_id",
8. "vault": {
9. "hdfs_info" : {
10. "build_conf": {
11. "fs_name": "hdfs://172.21.0.44:4007",
12. "user": "hadoop",
13. "hdfs_kerberos_keytab": "/etc/emr.keytab",
14. "hdfs_kerberos_principal": "hadoop/172.30.0.178@EMR-XXXYYY",
15. "hdfs_confs" : [
16. {
17. "key": "hadoop.security.authentication",
18. "value": "kerberos"
19. }
20. ]
21. },
22. "prefix": "sample_prefix"
23. }
24. }
25. }

创建基于对象存储为存储后端的请求

• 创建基于对象存储为存储后端的请求语法

1. PUT /MetaService/http/create_instance?token=<token HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain

5. {
6. "instance_id": string,
7. "name": string,
8. "user_id": string,
9. "vault": {
10. "obj_info": {
11. "ak": string,
12. "sk": string,
13. "bucket": string,
14. "prefix": string,
15. "endpoint": string,
16. "external_endpoint": string,
17. "region": string,
18. "provider": string
19. }
20. }
21. }

• 创建基于对象存储为存储后端的请求参数

• 创建基于对象存储为存储后端的请求示例

1. PUT /MetaService/http/create_instance?token=greedisgood9999 HTTP/1.1
2. Content-Length: 441
3. Content-Type: text/plain

5. {
6. "instance_id": "sample_instance_id",
7. "name": "sample_instance_name",
8. "user_id": "sample_user_id",
9. "vault": {
10. "obj_info": {
11. "ak": "ak_xxxxxxxxxxx",
12. "sk": "sk_xxxxxxxxxxx",
13. "bucket": "sample_bucket_name",
14. "prefix": "sample_prefix",
15. "endpoint": "cos.ap-beijing.myqcloud.com",
16. "external_endpoint": "cos.ap-beijing.myqcloud.com",
17. "region": "ap-beijing",
18. "provider": "COS"
19. }
20. }
21. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "ALREADY_EXISTED",
3. "msg": "instance already existed, instance_id=instance_id_deadbeef"
4. }

创建非存储后端的 Instance

提示

历史遗留接口，新版本已弃用，私有化部署请勿使用。

接口描述

本接口用于创建一个 Instance，该 Instance 仅使用 S3 作为其存储后端，并且只能使用一个存储后端。该 Instance 不包含任何节点信息，不能多次创建同一个 instance_id 的 Instance。

请求

• 请求语法

1. PUT /MetaService/http/create_instance?token=<token HTTP/1.1
2. Content-Length: <ContentLength
3. Content-Type: text/plain

5. {
6. "instance_id": string,
7. "name": string,
8. "user_id": string,
9. "obj_info": {
10. "ak": string,
11. "sk": string,
12. "bucket": string,
13. "prefix": string,
14. "endpoint": string,
15. "region": string,
16. "external_endpoint": string,
17. "provider": string
18. "user_id": string
19. },
20. "ram_user": {
21. "user_id": string,
22. "ak": string,
23. "sk": string
24. }
25. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/create_instance?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": "123456",
6. "name": "name",
7. "user_id": "abcdef",
8. "obj_info": {
9. "ak": "test-ak1",
10. "sk": "test-sk1",
11. "bucket": "test-bucket",
12. "prefix": "test-prefix",
13. "endpoint": "test-endpoint",
14. "region": "test-region",
15. "provider": "OBS",
16. "user_id": "xxx"
17. }
18. "ram_user": {
19. "user_id": string,
20. "ak": string,
21. "sk": string
22. }
23. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "ALREADY_EXISTED",
3. "msg": "instance already existed, instance_id=instance_id_deadbeef"
4. }

删除 Instance

接口描述

本接口用于删除一个已存在的 Instance，标记删除后，Recycler 会异步回收资源。

请求

• 请求语法

1. PUT /MetaService/http/drop_instance?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": string
6. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/drop_instance?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": "123456"
6. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INVALID_ARGUMENT",
3. "msg": "failed to drop instance, instance has clusters"
4. }

查询 Instance 信息

接口描述

本接口用于查询 Instance 下的信息（包括 S3 信息、Cluster 信息、Stage 信息等），可用于 Debug。

请求

• 请求语法

1. GET /MetaService/http/get_instance?token=greedisgood9999&instance_id={instance_id} HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain

• 请求参数

• 请求示例

1. GET /MetaService/http/get_instance?token=greedisgood9999&instance_id=test-instance HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": "",
4. "result": {
5. "user_id": "gavin-user-id",
6. "instance_id": "regression_instance0",
7. "name": "test-instance",
8. "clusters": [
9. {
10. "cluster_id": "RESERVED_CLUSTER_ID_FOR_SQL_SERVER",
11. "cluster_name": "RESERVED_CLUSTER_NAME_FOR_SQL_SERVER",
12. "type": "SQL",
13. "nodes": [
14. {
15. "cloud_unique_id": "1:regression_instance0:regression-cloud-unique-id-fe-1",
16. "ip": "127.0.0.1",
17. "ctime": "1669260437",
18. "mtime": "1669260437",
19. "edit_log_port": 12103,
20. "node_type": "FE_MASTER"
21. }
22. ]
23. },
24. {
25. "cluster_id": "regression_test_cluster_id0",
26. "cluster_name": "regression_test_cluster_name0",
27. "type": "COMPUTE",
28. "nodes": [
29. {
30. "cloud_unique_id": "1:regression_instance0:regression-cloud-unique-id0",
31. "ip": "127.0.0.1",
32. "ctime": "1669260437",
33. "mtime": "1669260437",
34. "heartbeat_port": 11102
35. }
36. ],
37. "mysql_user_name": [
38. "root"
39. ]
40. },
41. {
42. "cluster_id": "regression_test_cluster_id1",
43. "cluster_name": "regression_test_cluster_name1",
44. "type": "COMPUTE",
45. "nodes": [
46. {
47. "cloud_unique_id": "1:regression_instance0:regression-cloud-unique-id0",
48. "ip": "127.0.0.1",
49. "ctime": "1669260437",
50. "mtime": "1669260437",
51. "heartbeat_port": 14102
52. }
53. ],
54. "mysql_user_name": [
55. "jack",
56. "lx"
57. ]
58. },
59. {
60. "cluster_id": "regression_test_cluster_id2",
61. "cluster_name": "regression_test_cluster_name2",
62. "type": "COMPUTE",
63. "nodes": [
64. {
65. "cloud_unique_id": "1:regression_instance0:regression-cloud-unique-id0",
66. "ip": "127.0.0.1",
67. "ctime": "1669260437",
68. "mtime": "1669260437",
69. "heartbeat_port": 16102
70. }
71. ]
72. }
73. ],
74. "obj_info": [
75. {
76. "ctime": "1669260437",
77. "mtime": "1669260437",
78. "id": "1",
79. "ak": "akak",
80. "sk": "sksk",
81. "bucket": "justtmp-bj-1308700295",
82. "prefix": "dx-test",
83. "endpoint": "cos.ap-beijing.myqcloud.com",
84. "region": "ap-beijing",
85. "provider": "COS",
86. "external_endpoint": ""
87. }
88. ],
89. "stages": [
90. {
91. "mysql_user_name": [
92. "admin"
93. ],
94. "obj_info": {
95. "id": "1",
96. "prefix": "dx-test/stage/admin/admin"
97. },
98. "stage_id": "c56f5d01-0ae2-4719-8be2-8b52b3144f60",
99. "mysql_user_id": [
100. "admin"
101. ]
102. },
103. {
104. "type": "EXTERNAL",
105. "name": "smoke_test_tpch",
106. "obj_info": {
107. "ak": "akak",
108. "sk": "sksk",
109. "bucket": "gavin-test-bj",
110. "prefix": "smoke-test",
111. "endpoint": "oss-cn-beijing.aliyuncs.com",
112. "region": "cn-beijing",
113. "provider": "OSS"
114. },
115. "stage_id": "261c3565-7ac3-4cb5-9c82-a9bc38cff8e8",
116. "properties": {
117. "default.file.column_separator": "|"
118. }
119. }
120. ]
121. }
122. }

设置 Instance 状态

接口描述

本接口用于将某个 Instance 的状态设置为 NORMAL 或者 OVERDUE。

请求

• 请求语法

1. PUT /MetaService/http/set_instance_status?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": string
6. "op": string
7. }

• 请求参数

• 请求示例

1. curl '127.0.0.1:5000/MetaService/http/set_instance_status?token=greedisgood9999' -d '{
2. "instance_id":"test_instance",
3. "op": "SET_OVERDUE"
4. }'

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

获取 Instance 配置的 S3 信息

接口描述

本接口用于获取 Instance 配置的 S3 的 AK/SK 信息，此接口可使用相同参数调用多次。

请求

• 请求语法

1. PUT /MetaService/http/get_obj_store_info?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {"cloud_unique_id": "<cloud_unique_id>"}

• 请求参数

• 请求示例

1. PUT /MetaService/http/get_obj_store_info?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {"cloud_unique_id": "1:regression_instance0:cloud_unique_id_compute_node1"}

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": "",
4. "result": {
5. "obj_info": [
6. {
7. "ctime": "1662543056",
8. "mtime": "1662543056",
9. "id": "1",
10. "ak": "xxxx",
11. "sk": "xxxxx",
12. "bucket": "doris-xxx-1308700295",
13. "prefix": "selectdb-xxxx-regression-prefix",
14. "endpoint": "cos.ap-yyy.xxxx.com",
15. "region": "ap-xxx"
16. }
17. ]
18. }
19. }

• 失败返回示例

1. {
2. "code": "INVALID_ARGUMENT",
3. "msg": "empty instance_id"
4. }

更新 Instance 的 AK/SK 信息

接口描述

本接口用于更新 Instance 配置的 S3 和 RAM_USER 的 AK/SK 信息，使用 user_id 查询修改项，一般用于 AK/SK 轮转，使用相同参数调用此接口会报错。

请求

• 请求语法

1. PUT /MetaService/http/update_ak_sk?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": string,
6. "internal_bucket_user":[
7. {
8. "user_id": string,
9. "ak": string,
10. "sk": string
11. },
12. {
13. "user_id": string,
14. "ak": string,
15. "sk": string
16. }
17. ],
18. "ram_user": {
19. "user_id": string,
20. "ak": string,
21. "sk": string
22. }
23. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/update_ak_sk?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id":"test",
6. "internal_bucket_user":[
7. {
8. "user_id": "bucket_user_id_1",
9. "ak": "xxxx",
10. "sk": "xxxx"
11. },
12. {
13. "user_id": "bucket_user_id_2",
14. "ak": "xxxx",
15. "sk": "xxxx"
16. }
17. ],
18. "ram_user": {
19. "user_id": "ram_user_id",
20. "ak": "xxxx",
21. "sk": "xxxx"
22. }
23. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INVALID_ARGUMENT",
3. "msg": "ak sk eq original, please check it"
4. }

更新 Instance 的 AK/SK 信息（历史遗留接口新版本已弃用）

接口描述

本接口用于更新 Instance 配置的 S3 的 AK/SK 信息，使用 ID 查询修改项，ID 可由 get_obj_store_info 查询而得。此接口使用相同参数多次调用会报错。

请求

• 请求语法

1. PUT /MetaService/http/legacy_update_ak_sk?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": string,
6. "obj": {
7. "id": string,
8. "ak": string,
9. "sk": string,
10. }
11. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/legacy_update_ak_sk?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": "1:regression_instance0:cloud_unique_id_compute_node1",
6. "obj": {
7. "id": "1",
8. "ak": "test-ak",
9. "sk": "test-sk",
10. }
11. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INVALID_ARGUMENT",
3. "msg": "ak sk eq original, please check it"
4. }

添加 Instance 的 S3 信息

接口描述

本接口用于添加 Instance 配置的 S3 的信息，最多支持添加 10 条 S3 信息，每条配置最多不超过 1024 字节大小。

请求

• 请求语法

1. PUT /MetaService/http/add_obj_info?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": string,
6. "obj": {
7. "ak": string,
8. "sk": string,
9. "bucket": string,
10. "prefix": string,
11. "endpoint": string,
12. "region": string
13. }
14. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/add_obj_info?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": "1:regression_instance0:cloud_unique_id_compute_node1",
6. "obj": {
7. "ak": "test-ak91",
8. "sk": "test-sk1",
9. "bucket": "test-bucket",
10. "prefix": "test-prefix",
11. "endpoint": "test-endpoint",
12. "region": "test-region"
13. }
14. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INVALID_ARGUMENT",
3. "msg": "s3 conf info err, please check it"
4. }

创建计算集群

接口描述

本接口用于创建一个属于 Instance 的计算集群。该计算集群中包含若干（大于等于 0 个）相同类型节点信息，此接口不能用同一参数调用。

请求

• 请求语法

1. PUT /MetaService/http/add_cluster?token=<token HTTP/1.1
2. Content-Length: <ContentLength
3. Content-Type: text/plain

5. {
6. "instance_id": string,
7. "cluster": object {
8. "cluster_name": string,
9. "cluster_id": string,
10. "type": enum,
11. "nodes": [
12. {
13. "cloud_unique_id": string,
14. "ip": string,
15. "heartbeat_port": int
16. }
17. ]
18. }
19. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/add_cluster?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": "123456",
6. "cluster": {
7. "cluster_name": "cluster_name1",
8. "cluster_id": "cluster_id1",
9. "type": "COMPUTE",
10. "nodes": [
11. {
12. "cloud_unique_id": "1:regression_instance0:cloud_unique_id_compute_node1",
13. "ip": "172.21.0.5",
14. "heartbeat_port": 9050
15. }
16. ]
17. }
18. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INTERANAL_ERROR",
3. "msg": "cluster is SQL type, must have only one master node, now master count: 0"
4. }

获取计算集群

接口描述

本接口用于获取一个计算集群的信息，此接口可以多次重复调用。

请求

• 请求语法

1. PUT /MetaService/http/get_cluster?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id":string,
6. "cloud_unique_id":string,
7. "cluster_name":string,
8. "cluster_id":string
9. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/get_cluster?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id":"regression_instance0",
6. "cloud_unique_id":"1:regression_instance0:regression-cloud-unique-id-fe-1",
7. "cluster_name":"RESERVED_CLUSTER_NAME_FOR_SQL_SERVER",
8. "cluster_id":"RESERVED_CLUSTER_ID_FOR_SQL_SERVER"
9. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": "",
4. "result": {
5. "cluster_id": "cluster_id1",
6. "cluster_name": "cluster_name1",
7. "type": "COMPUTE",
8. "nodes": [
9. {
10. "cloud_unique_id": "1:regression_instance0:cloud_unique_id_compute_node0",
11. "ip": "172.21.16.42",
12. "ctime": "1662695469",
13. "mtime": "1662695469",
14. "heartbeat_port": 9050
15. }
16. ]
17. }
18. }

• 失败返回示例

1. {
2. "code": "NOT_FOUND",
3. "msg": "fail to get cluster with instance_id: \"instance_id_deadbeef\" cloud_unique_id: \"1:regression_instance0:xxx_cloud_unique_id_compute_node0\" cluster_name: \"cluster_name\" "
4. }

删除计算集群

接口描述

本接口用于删除一个 Instance 下的某个计算集群的信息，此接口若多次使用相同参数调用会报错。

请求

• 请求语法

1. PUT /MetaService/http/drop_cluster?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id":string,
6. "cluster": {
7. "cluster_name": string,
8. "cluster_id": string,
9. }
10. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/drop_cluster?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id":"regression_instance0",
6. "cluster": {
7. "cluster_name": "cluster_name1",
8. "cluster_id": "cluster_id1",
9. }
10. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INTERANAL_ERROR",
3. "msg": "failed to find cluster to drop, instance_id=dx_dnstance_id_deadbeef cluster_id=11111 cluster_name=2222"
4. }

计算集群重命名

接口描述

本接口用于将 Instance 下的计算集群重命名，依据传入的 cluster_id 寻找相应的 cluster_name 进行重命名，此接口若多次使用相同参数调用会报错。

请求

• 请求语法

1. PUT /MetaService/http/rename_cluster?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id":string,
6. "cluster": {
7. "cluster_name": string,
8. "cluster_id": string,
9. }
10. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/rename_cluster?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id":"regression_instance0",
6. "cluster": {
7. "cluster_name": "cluster_name2",
8. "cluster_id": "cluster_id1",
9. }
10. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INTERANAL_ERROR",
3. "msg": "failed to rename cluster, name eq original name, original cluster is {\"cluster_id\":\"3333333\",\"cluster_name\":\"444444\",\"type\":\"COMPUTE\"}"
4. }

计算集群添加节点

接口描述

本接口用于将 Instance 下的某计算集群添加若干相同类型的节点，此接口若多次使用相同参数调用会报错。

本接口可用于添加 FE 或者 BE 节点。

请求

• 请求语法

1. PUT /MetaService/http/add_node?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": string,
6. "cluster": {
7. "cluster_name": string,
8. "cluster_id": string,
9. "type": enum,
10. "nodes": [
11. {
12. "cloud_unique_id": string,
13. "ip": string,
14. "heartbeat_port": int
15. },
16. {
17. "cloud_unique_id": string,
18. "ip": string,
19. "heartbeat_port": int
20. }
21. ]
22. }
23. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/add_node?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": "instance_id_deadbeef_1",
6. "cluster": {
7. "cluster_name": "cluster_name1",
8. "cluster_id": "cluster_id1",
9. "type": "COMPUTE",
10. "nodes": [
11. {
12. "cloud_unique_id": "1:regression_instance0:cloud_unique_id_compute_node2",
13. "ip": "172.21.0.50",
14. "heartbeat_port": 9051
15. },
16. {
17. "cloud_unique_id": "1:regression_instance0:cloud_unique_id_compute_node3",
18. "ip": "172.21.0.52",
19. "heartbeat_port": 9052
20. }
21. ]
22. }
23. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INTERANAL_ERROR",
3. "msg": "cloud_unique_id is already occupied by an instance, instance_id=instance_id_deadbeef_1 cluster_name=dx_cluster_name1 cluster_id=cluster_id1 cloud_unique_id=cloud_unique_id_compute_node2"
4. }

计算集群减少节点

接口描述

本接口用于将 Instance 下的某计算集群减少若干相同类型的节点。

请求

• 请求语法

1. PUT /MetaService/http/drop_node?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": string,
6. "cluster": {
7. "cluster_name": string,
8. "cluster_id": string,
9. "type": enum,
10. "nodes": [
11. {
12. "cloud_unique_id": string,
13. "ip": string,
14. "heartbeat_port": int
15. },
16. {
17. "cloud_unique_id": string,
18. "ip": string,
19. "heartbeat_port": int
20. }
21. ]
22. }
23. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/drop_node?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": "instance_id_deadbeef_1",
6. "cluster": {
7. "cluster_name": "cluster_name1",
8. "cluster_id": "cluster_id1",
9. "type": "COMPUTE",
10. "nodes": [
11. {
12. "cloud_unique_id": "1:instance_id_deadbeef_1:cloud_unique_id_compute_node2",
13. "ip": "172.21.0.50",
14. "heartbeat_port": 9051
15. },
16. {
17. "cloud_unique_id": "1:instance_id_deadbeef_1:cloud_unique_id_compute_node3",
18. "ip": "172.21.0.52",
19. "heartbeat_port": 9052
20. }
21. ]
22. }
23. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INTERANAL_ERROR",
3. "msg": "cloud_unique_id can not find to drop node, instance_id=instance_id_deadbeef_1 cluster_name=cluster_name1 cluster_id=cluster_id1 cloud_unique_id=cloud_unique_id_compute_node2"
4. }

为计算集群添加默认 user_name

接口描述

本接口用于为 Instance 下的某计算集群添加用户名，使相应用户可以使用 MySQL Client 登录系统，使用默认计算集群。

请求

• 请求语法

1. PUT /MetaService/http/update_cluster_mysql_user_name?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": string,
6. "cluster": {
7. "cluster_name": "string",
8. "cluster_id": "string",
9. "mysql_user_name": [
10. string
11. ]
12. }
13. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/update_cluster_mysql_user_name?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": "instance_id_deadbeef",
6. "cluster": {
7. "cluster_name": "cluster_name2",
8. "cluster_id": "cluster_id1",
9. "mysql_user_name": [
10. "jack",
11. "root"
12. ]
13. }
14. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INTERANAL_ERROR",
3. "msg": "no mysql user name to change"
4. }

获取计算集群下的 BE 节点执行情况

接口描述

本接口用于获取计算集群下，BE 节点运行 Fragment 的情况。

备注

此接口是请求 FE 的接口。

请求

• 请求语法

1. GET /rest/v2/manager/cluster/cluster_info/cloud_cluster_status HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain

• 请求参数

• 请求示例

1. curl -u root: http://127.0.0.1:12100/rest/v2/manager/cluster/cluster_info/cloud_cluster_status

• 返回参数

• 成功返回示例

1. {
2. "msg": "success",
3. "code": 0,
4. "data": {
5. "regression_cluster_id2": [
6. {
7. "host": "127.0.0.1",
8. "heartbeatPort": 14102,
9. "bePort": -1,
10. "httpPort": -1,
11. "brpcPort": -1,
12. "currentFragmentNum": 0,
13. "lastFragmentUpdateTime": 0
14. }
15. ],
16. "regression_test_cluster_id0": [
17. {
18. "host": "127.0.0.1",
19. "heartbeatPort": 11102,
20. "bePort": 11100,
21. "httpPort": 11101,
22. "brpcPort": 11103,
23. "currentFragmentNum": 3,
24. "lastFragmentUpdateTime": 1684152350291
25. }
26. ]
27. },
28. "count": 0
29. }

开启 Instance 对象数据服务端加密

接口描述

本接口用于开启 Instance 对象数据服务端加密。

请求

• 请求语法

1. PUT /MetaService/http/enable_instance_sse?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": string
6. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/enable_instance_sse?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_id": "123456"
6. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

• 失败返回示例

1. {
2. "code": "INVALID_ARGUMENT",
3. "msg": "failed to enable sse, instance has enabled sse"
4. }

获取计算集群的运行状态

接口描述

本接口用于获取多个 Instance 下的计算集群运行状态。

请求

• 请求语法

1. PUT /MetaService/http/get_cluster_status?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "instance_ids": [string, string],
6. "status": string
7. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/get_cluster_status?token=greedisgood9999 HTTP/1.1
2. Content-Length: 109
3. Content-Type: text/plain
4. {
5. "instance_ids":["regression_instance-dx-1219", "regression_instance-dx-0128"],
6. "status":"NORMAL"
7. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": "",
4. "result": {
5. "details": [
6. {
7. "instance_id": "regression_instance-dx-1219",
8. "clusters": [
9. {
10. "cluster_id": "regression_cluster_id2",
11. "cluster_name": "regression_cluster_name2-changed-again",
12. "cluster_status": "NORMAL"
13. },
14. {
15. "cluster_id": "regression_cluster_id3",
16. "cluster_name": "regression_cluster_name3",
17. "cluster_status": "NORMAL"
18. },
19. {
20. "cluster_id": "regression_test_cluster_id0",
21. "cluster_name": "regression_test_cluster_name0",
22. "cluster_status": "NORMAL"
23. }
24. ]
25. }
26. ]
27. }
28. }

设置计算集群的运行状态

接口描述

本接口用于设置某个 Instance 下的计算集群运行状态。

请求

• 请求语法

1. PUT /MetaService/http/set_cluster_status?token=<token> HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": string,
6. "cluster": {
7. "cluster_id": string,
8. "cluster_status":string
9. }
10. }

• 请求参数

• 请求示例

1. PUT /MetaService/http/set_cluster_status?token=greedisgood9999 HTTP/1.1
2. Content-Length: 128
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": "1:regression_instance0:regression-cloud-unique-id-fe-0128",
6. "cluster": {
7. "cluster_id": "test_cluster_1_id1",
8. "cluster_status":"STOPPED"
9. }
10. }

• 返回参数

• 成功返回示例

1. {
2. "code": "OK",
3. "msg": ""
4. }

由于该接口由云管平台与 FE 共同使用，设置状态时，需遵守特定的状态变化限制。只允许以下状态变换：

• ClusterStatus::UNKNOWN -> ClusterStatus::NORMAL（云管平台创建计算集群时，将初始状态直接置为 NORMAL，此操作通常在 add_cluster 接口中完成）
• ClusterStatus::NORMAL -> ClusterStatus::SUSPENDED（云管平台暂停计算集群时设置）
• ClusterStatus::SUSPENDED -> ClusterStatus::TO_RESUME（FE 唤起计算集群时设置）
• ClusterStatus::TO_RESUME -> ClusterStatus::NORMAL（云管平台将计算集群状态拉起后设置）

若尝试执行以上未列出的状态变换，系统将返回错误提示：

1. {
2. "code": "INVALID_ARGUMENT",
3. "msg": "failed to set cluster status, original cluster is NORMAL and want set TO_RESUME"
4. }

解码 Meta Service 中的 Key 信息

接口描述

本接口用于 decode Meta Service Log 中的 Key 信息，用于调试。

请求

• 请求语法

1. GET /MetaService/http/decode_key?token=greedisgood9999&key={key} HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain

• 请求参数

• 请求示例

1. GET /MetaService/http/decode_key?token=greedisgood9999&key=0110696e7374616e636500011072656772657373696f6e5f696e7374616e6365300001 HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain

• 成功返回示例

1. ┌───────────────────────── 0. key space: 1
2. │ ┌─────────────────────── 1. instance
3. │ │                     ┌─ 2. regression_instance0
4. │ │                     │
5. ▼ ▼                     ▼
6. 0110696e7374616e636500011072656772657373696f6e5f696e7374616e6365300001

查询 Tablet 状态

接口描述

本接口用于查询 Tablet 状态，用于调试。

请求

• 请求语法

1. POST /MetaService/http/get_tablet_stats?token=greedisgood9999 HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": string,
6. "tablet_idx": [{
7. "table_id": int64,
8. "index_id": int64,
9. "partition_id": int64,
10. "tablet_id": int64
11. }]
12. }

• 请求参数

• 请求示例

1. POST /MetaService/http/get_tablet_stats?token=greedisgood9999 HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id":"1:regression_instance0:regression-cloud-unique-id0",
6. "tablet_idx": [{
7. "table_id":113973,
8. "index_id":113974,
9. "partition_id":113966,
10. "tablet_id":114739
11. }]
12. }

• 成功返回示例

1. status {
2. code: OK
3. msg: ""
4. }
5. tablet_stats {
6. idx {
7. table_id: 113973
8. index_id: 113974
9. partition_id: 113966
10. tablet_id: 114739
11. }
12. data_size: 0
13. num_rows: 0
14. num_rowsets: 2
15. num_segments: 0
16. base_compaction_cnt: 0
17. cumulative_compaction_cnt: 0
18. cumulative_point: 2
19. }

Abort 事务

接口描述

本接口用于 Abort 事务，用于调试。

请求

• 请求语法

1. POST /MetaService/http/abort_txn?token=greedisgood9999 HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": string,
6. "txn_id": int64
7. }
8. or
9. {
10. "cloud_unique_id": string,
11. "db_id": int64,
12. "label": string
13. }

• 请求参数

• 请求示例

1. POST /MetaService/http/abort_txn?token=greedisgood9999 HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": "1:regression_instance0:regression-cloud-unique-id0",
6. "txn_id": 869414052004864
7. }

• 成功返回示例

1. status {
2. code: OK
3. msg: ""
4. }

Abort Tablet Job

接口描述

本接口用于 Abort Tablet 上的 Job，当前只支持 Compaction Job，用于调试。

请求

• 请求语法

1. POST /MetaService/http/abort_tablet_job?token=greedisgood9999 HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": string,
6. "job" : {
7. "idx": {"tablet_id": int64},
8. "compaction": [{"id": string}]
9. }
10. }

• 请求参数

• 请求示例

1. POST /MetaService/http/abort_tablet_job?token=greedisgood9999 HTTP/1.1
2. Content-Length: <ContentLength>
3. Content-Type: text/plain
4. {
5. "cloud_unique_id": "1:regression_instance0:regression-cloud-unique-id0",
6. "job" : {
7. "idx": {"tablet_id": 113973},
8. "compaction": [{"id": 113974}]
9. }
10. }

• 成功返回示例

1. status {
2. code: OK
3. msg: ""
4. }