DescribeProcessList - 查看正在运行中的查询

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
clickhouse:DescribeProcessListlist
*EnterpriseDBCluster
acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-beijing
DBInstanceIdstring

集群 ID。

cc-xxxxx
QueryDurationMsstring

慢 SQL 的执行耗时,单位 ms,最小 1000 ms。

1000
InitialUserstring

查询用户。

testuser
Keywordstring

查询语句的关键字。

SELECT
InitialQueryIdstring

查询 ID。

1
QueryOrderlong

按指定列倒序排序。

  • 0 表示仅用 query_duration_ms 排序

  • 1 表示用 query_duration_ms、query_start_time 排序

  • 2 表示用 query_duration_ms、query_start_time、user 排序

0
PageSizeinteger

每页记录数。

30
PageNumberinteger

页码。

1

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

xxx-xxx-xxx
Dataobject

返回的结果。

DBInstanceIDinteger

集群 ID。

cc-xxxx
DBInstanceNamestring

集群名称。

测试使用
TotalCountinteger

总记录数。

1
ResultSetarray<object>

结果集。

ResultSetobject
InitialQueryIdstring

查询 ID。

'79f7e40b-87e2-4ef4-b6df-21889a3a030e'
QueryStartTimestring

查询开始时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2023-07-23T10:13:23Z
InitialAddressstring

查询地址。

0:0:0:0:0:ffff:1edd65ea
Querystring

正在查询的语句。

select * from test
InitialUserstring

查询用户。

bany
QueryDurationMslong

最短的查询耗时。最小值为 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
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-13API 内部配置变更,不影响调用查看变更详情