DescribeProcessList - 查看实例正在运行的查询 - 云数据库 ClickHouse

调用DescribeProcessList接口查询云数据库ClickHouse社区兼容版集群正在运行的查询。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:DescribeProcessList	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。	cn-hangzhou
DBClusterId	string	是	集群 ID。您可以通过调用 DescribeDBClusters 接口查询目标地域下所有的集群信息，包括集群 ID。	cc-bp1190tj036am****
QueryDurationMs	integer	是	最短的查询耗时。最小值为 1000，默认值为 1000。单位：毫秒。返回参数将返回超过该耗时的查询。	500
InitialUser	string	否	数据库账号。	user
Keyword	string	否	查询关键字。	join
Order	string	否	按指定列名排序，取值： elapsed：累计执行时间 written_rows：写入行数 read_rows：读取行数 memory_usage：内存使用量	elapsed
PageSize	integer	否	每页记录数，取值： 30（默认值） 50 100	30
PageNumber	integer	否	页码，取值为：大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
InitialQueryId	string	否	查询语句的 ID。	6c69d508-f05f-4c74-857c-d982b7e7e79f

返回参数

名称	类型	描述	示例值
	object	返回的结果。
RequestId	string	请求 ID。	FD61BB0D-788A-5185-A8E3-1B90BA8F6F04
ProcessList	object	任务列表
TableSchema	array<object>	列表详情。
ResultSet	object
Type	string	列类型。	String
Name	string	列名。	InitialUser
Data	array<object>	任务详情。
ResultSet	object
QueryStartTime	string	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-02-02T09:14:48Z
Query	string	查询语句。	select * from test order by score limit 1;
InitialAddress	string	发起查询的客户端 IP 地址。	::ffff:10.1.XX.XX
InitialQueryId	string	查询 ID。	2dd144fd-4230-4249-b15c-e63f964fbb5a
InitialUser	string	数据库账号。	test
QueryDurationMs	string	查询耗时。单位：毫秒。	2000
Rows	string	查询返回的数据行数。	1145700
RowsBeforeLimitAtLeast	string	分页大小。	1
Statistics	object	查询结果的统计信息。
RowsRead	integer	扫描数据行数。	1000000
ElapsedTime	float	平均响应时间。	4156
BytesRead	integer	扫描数据大小。单位：Byte。	9141300000

示例

正常返回示例

JSON格式

{
  "RequestId": "FD61BB0D-788A-5185-A8E3-1B90BA8F6F04",
  "ProcessList": {
    "TableSchema": {
      "ResultSet": [
        {
          "Type": "String",
          "Name": "InitialUser"
        }
      ]
    },
    "Data": {
      "ResultSet": [
        {
          "QueryStartTime": "2021-02-02T09:14:48Z",
          "Query": "select * from test order by score limit 1;",
          "InitialAddress": "::ffff:10.1.XX.XX",
          "InitialQueryId": "2dd144fd-4230-4249-b15c-e63f964fbb5a",
          "InitialUser": "test",
          "QueryDurationMs": "2000"
        }
      ]
    },
    "Rows": "1145700",
    "RowsBeforeLimitAtLeast": "1",
    "Statistics": {
      "RowsRead": 1000000,
      "ElapsedTime": 4156,
      "BytesRead": 9141300000
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request.	系统内部错误，请稍后重试
503	ServiceUnavailable	An error occurred while processing your request.	系统暂时不可用，请稍后重试

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

变更历史

变更时间	变更内容概要	操作
2024-09-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情