调用DescribeProcessList API查看正在运行的查询-云数据库 ClickHouse-阿里云

调用DescribeProcessList接口查看正在运行中的查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:DescribeProcessList

list

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-beijing
DBInstanceId	string	是	集群 ID。	cc-xxxxx
QueryDurationMs	string	否	慢 SQL 的执行耗时，单位 ms，最小 1000 ms。	1000
InitialUser	string	否	查询用户。	testuser
Keyword	string	否	查询语句的关键字。	SELECT
InitialQueryId	string	否	查询 ID。	1
QueryOrder	integer	否	按指定列倒序排序。 0 表示仅用 query_duration_ms 排序 1 表示用 query_duration_ms、query_start_time 排序 2 表示用 query_duration_ms、query_start_time、user 排序	0
PageSize	integer	否	每页记录数。	30
PageNumber	integer	否	页码。	1
ComputingGroupId	string	否

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	xxx-xxx-xxx
Data	object	返回的结果。
DBInstanceID	integer	集群 ID。	cc-xxxx
DBInstanceName	string	集群名称。	测试使用
TotalCount	integer	总记录数。	1
ResultSet	array<object>	结果集。
	object
InitialQueryId	string	查询 ID。	'79f7e40b-87e2-4ef4-b6df-21889a3a030e'
QueryStartTime	string	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2023-07-23T10:13:23Z
InitialAddress	string	查询地址。	0:0:0:0:0:ffff:1edd65ea
Query	string	正在查询的语句。	select * from test
InitialUser	string	查询用户。	bany
QueryDurationMs	integer	最短的查询耗时。最小值为 1000。单位：毫秒。	1000

示例

正常返回示例

JSON格式

{
  "RequestId": "xxx-xxx-xxx",
  "Data": {
    "DBInstanceID": 0,
    "DBInstanceName": "测试使用",
    "TotalCount": 1,
    "ResultSet": [
      {
        "InitialQueryId": "'79f7e40b-87e2-4ef4-b6df-21889a3a030e'",
        "QueryStartTime": "2023-07-23T10:13:23Z",
        "InitialAddress": "0:0:0:0:0:ffff:1edd65ea",
        "Query": "select * from test",
        "InitialUser": "bany",
        "QueryDurationMs": 1000
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。