更新时间:2025-11-21 GMT+08:00
分享

删除订阅 - DeleteSubscription

功能介绍

删除订阅信息。

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:update

write

-

-

rds:instance:modify

-

URI

  • URI格式

    DELETE /v3/{project_id}/instances/{instance_id}/replication/subscriptions

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释:

    租户在某一region下的project ID。

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

    约束限制:

    非空。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    参数解释:

    实例ID。

    约束限制:

    非空。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

subscription_ids

Array of strings

参数解释:

删除的订阅ID列表。

约束限制:

每次删除的订阅必须属于同一实例。

取值范围:

不涉及。

默认取值:

不涉及。

clean_subscription

Boolean

参数解释:

清理订阅配置。

约束限制:

不涉及。

取值范围:

  • true:清理订阅配置。
  • false:不清理订阅配置。

默认取值:

false

请求示例

删除订阅信息。

DELETE https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/subscriptions

{
    "subscription_ids": [
        "5dafb44b-85ac-46b0-ae8b-a7b95c79bb1c"
    ],
    "clean_subscription": false
}

响应消息

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

    名称

    参数类型

    说明

    job_id

    String

    参数解释:

    任务ID。

    取值范围:

    不涉及。

  • 正常响应样例
    {
        "job_id": "ad1a17bc-7ee2-4756-89c5-c2ef605f3265"
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档