# 查询数据库代理作业执行历史步骤 - ListDbAgentJobHistorySteps #### 功能介绍 查询数据库代理作业执行历史步骤信息。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListDbAgentJobHistorySteps)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | 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](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | history_id | 是 | **参数解释：** 作业执行历史ID。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 10 | #### 请求消息 - 请求参数 无。 - URI样例 GET https://{*Endpoint*}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/db-jobs/histories/48061/steps?offset=0\&limit=10 #### 响应消息 - 正常响应要素说明 表2要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | steps | Array of objects | **参数解释：** 执行历史步骤列表。 详情请参见[表3]。 | | total_count | Integer | **参数解释：** 执行历史步骤总数。 **取值范围：** 不涉及。 | 表3steps元素结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | 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 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。