文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 发布订阅（SQL Server）/ 修改数据库代理作业 - ModifyDbAgentJob
更新时间：2025-12-02 GMT+08:00
查看PDF
分享

修改数据库代理作业 - ModifyDbAgentJob

功能介绍

修改数据库代理作业。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:update

write

-

-

rds:instance:modify

-

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/db-jobs/{job_id}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    job_id

    是

    参数解释：

    作业ID。

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

profile_id

是

String

参数解释：

配置文件ID。

约束限制：

不涉及。

取值范围：

必须为数字字符串。

默认取值：

不涉及。

请求示例

修改数据库代理作业。

PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/db-jobs/0C6A3BC7-D2D5-41C2-BA3A-012DC43C4CD5

{
    "profile_id": "10"
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    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

    参数解释：

    作业执行状态。

    取值范围：

    • 0：失败。
    • 1：成功。
    • 2：重试中。
    • 3：已取消。
    • 4：正在运行。

    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。

    取值范围：

    不涉及。

    profile_name

    String

    参数解释：

    配置文件名。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
    "job_id": "B62A0ACC-1B87-48A4-9033-DEECE3CA15D7",
    "job_name": "MSSQL-4AE204B9\\MSSQL2-db01-pub01-192.168.0.135-11",
    "is_enabled": true,
    "run_time": "2025-11-04T03:33:43+0000",
    "run_status": "4",
    "failure_count": 0,
    "agent_type": "distribution",
    "profile_id": "10",
    "profile_name": "Windows Synchronization Manager profile"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

相关文档