查询数据库代理作业执行历史步骤 - ListDbAgentJobHistorySteps
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
rds:instance:update |
write |
- |
- |
rds:instance:modify |
- |
URI
- URI格式
GET /v3/{project_id}/instances/{instance_id}/db-jobs/histories/{history_id}/steps?offset={offset}&limit={limit}
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
history_id
是
参数解释：
作业执行历史ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
offset
否
参数解释：
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。
约束限制：
不涉及。
取值范围：
必须为数字，不能为负数。
默认取值：
默认为0（偏移0条数据，表示从第一条数据开始查询）。
limit
否
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
1~100
默认取值：
10
请求消息
响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
steps
Array of objects
参数解释：
执行历史步骤列表。
详情请参见表3。
total_count
Integer
参数解释：
执行历史步骤总数。。
取值范围：
不涉及。
表3 steps元素结构说明 名称
参数类型
说明
step_id
String
参数解释：
步骤id。
取值范围：
不涉及。
step_name
String
参数解释：
步骤名。
取值范围：
不涉及。
run_status
String
参数解释：
作业执行状态。
取值范围：
- failed：失败。
- succeeded：成功。
- retrying：重试中。
- canceled：已取消。
- in_progress：正在运行。
run_time
String
参数解释：
最新执行时间，格式：yyyy-mm-ddThh:mm:ssZ。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
取值范围：
不涉及。
run_duration
String
参数解释：
作业执行时长，格式：hh:mm:ss
取值范围：
不涉及。
message
String
参数解释：
执行信息。
取值范围：
不涉及。
- 正常响应样例
{ "steps": [ { "step_id": "1", "step_name": "Run agent.", "run_time": "2025-11-16T07:39:00+0000", "run_status": "succeeded", "run_duration": "00:00:00", "message": "Executed as user: NT SERVICE\\SQLAgent$MSSQL2019EE. The step succeeded." } ], "total_count": 1 } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
