DescribeProcessList - 查看集群正在运行的查询

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

调试

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

授权信息

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

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

请求参数

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

集群 ID。

am-bp11q28kvl688****
ShowFullboolean

是否展示完整的 SQL 语句。取值说明:

  • True:展示完整的 SQL 语句。
  • False:只展示 SQL 语句的前 100 个字符。
说明 默认值 False。
True
RunningTimeinteger

按运行时间过滤,展示大于该运行时间的查询。单位:秒。

5
Userstring

按用户名过滤。

test
Keywordstring

过滤关键字,目前仅支持过滤 SELECT

SELECT
Orderstring

按指定字段排序,JSON 格式,[{"Field":"Time","Type":"Desc" },{ "Field":"User", "Type":"Asc" }],取值说明:

  • Field:需要排序的字段名,支持 Time,User,Host,DB 字段。
  • Type:排序类型,Desc 为降序,Asc 为升序。
[ { "Field":"Time","Type":"Desc" }, { "Field":"User", "Type":"Asc" }]
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页码,取值为:大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1

返回参数

名称类型描述示例值
object
TotalCountstring

总记录数。

1
PageSizestring

总页数。

30
RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberstring

页码。

1
Itemsarray<object>

任务列表。

Processobject
StartTimestring

任务的开始时间,UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。

2020-11-19T02:48:15Z
Timeinteger

查询任务已运行时间。单位:秒。

11
ProcessIdstring

任务的唯一标识,KILL PROCESS 时使用。

202011191048151921681492420315100****
Hoststring

发起查询的 IP 地址。

192.168.XX.XX:12308
DBstring

数据库名。

adb_demo
Commandstring

命令类型,仅支持 SELECT 类型。

SELECT
Userstring

用户名。

test
Idinteger

工作线程 ID。

49104
Infostring

正在运行的 SQL 语句,默认返回前 100 字符。当传入参数 ShowFull 为 True 时,显示全文。

select * from sbtest1,sbtest2,sbtest3,sbtest4

示例

正常返回示例

JSON格式

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": "1",
  "Items": {
    "Process": [
      {
        "StartTime": "2020-11-19T02:48:15Z",
        "Time": 11,
        "ProcessId": "202011191048151921681492420315100****",
        "Host": "192.168.XX.XX:12308",
        "DB": "adb_demo",
        "Command": "SELECT",
        "User": "test",
        "Id": 49104,
        "Info": "select * from sbtest1,sbtest2,sbtest3,sbtest4"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400IncorrectModuleVersionThe specified module version does not support this operation.模块版本不支持该操作。
400AnalyticDBKernelErrorCalling AnalyticDB Kernel error-
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
2023-04-06OpenAPI 错误码发生变更查看变更详情