# 查询数据库代理作业列表 - ListDbAgentJobs #### 功能介绍 查询数据库代理作业列表。 - 调用接口前，您需要了解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=ListDbAgentJobs)中调试该接口。 #### 授权信息 账号具备所有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?offset={offset}\&limit={limit}\&job_type={job_type} - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 10 | | job_type | 否 | **参数解释：** 作业类型。 **约束限制：** 不涉及。 **取值范围：** replication：发布订阅相关作业。 **默认取值：** replication | #### 请求消息 - 请求参数 无。 - URI样例 GET https://{*Endpoint*}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/db-jobs?offset=0\&limit=10\&job_type=replication #### 响应消息 - 正常响应要素说明 表2要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | jobs | Array of objects | **参数解释：** 作业列表。 详情请参见[表3]。 | | total_count | Integer | **参数解释：** 作业总数。 **取值范围：** 不涉及。 | 表3jobs元素结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | job_id | String | **参数解释：** 作业ID。 **取值范围：** 不涉及。 | | job_name | String | **参数解释：** 作业名。 **取值范围：** 不涉及。 | | is_enabled | Boolean | **参数解释：** 是否可用。 **取值范围：** - true：可用。 - false：不可用。 | | run_time | String | **参数解释：** 最新执行时间，格式：yyyy-mm-ddThh:mm:ssZ。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | run_status | String | **参数解释：** 作业执行状态。 **取值范围：** - failed：失败。 - succeeded：成功。 - retrying：重试中。 - canceled：已取消。 - in_progress：正在运行。 | | last_failure_time | String | **参数解释：** 最近失败时间，格式：yyyy-mm-ddThh:mm:ssZ。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | failure_count | Integer | **参数解释：** 历史失败次数。 **取值范围：** 不涉及。 | | agent_type | String | **参数解释：** 作业代理的类型。 **取值范围：** - snapshot：快照代理。 - log_reader：日志读取器代理。 - distribution：分发代理。 - merge：合并代理。 - queue_reader：队列读取器代理。 | | profile_id | String | **参数解释：** 配置文件ID。作业类型为replication时该参数有效。 **取值范围：** 不涉及。 | | profile_name | String | **参数解释：** 配置文件名。作业类型为replication时该参数有效。 **取值范围：** 不涉及。 | - 正常响应样例 ``` { "jobs": [ { "job_id": "0C6A3BC7-D2D5-41C2-BA3A-012DC43C4CD5", "job_name": "Monitor and sync replication agent jobs", "is_enabled": true, "run_time": "2025-11-08T10:58:00+0000", "run_status": "succeeded", "failure_count": 0, "profile_id": "0" }, { "job_id": "F19D8EDB-B248-4ECD-BA92-F588DA687AFD", "job_name": "Replication agents checkup", "is_enabled": true, "run_time": "2025-11-08T10:50:00+0000", "run_status": "succeeded", "failure_count": 0, "profile_id": "0" } ], "total_count": 2 } ``` - 异常响应 请参见[异常响应结果](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)。