You need to enable JavaScript to run this app.
导航
DeleteDBNodes
最近更新时间:2025.01.22 12:04:50首次发布时间:2025.01.22 12:04:50

调用 DeleteDBNodes 接口为实例移除节点。

请求类型

异步请求。

调试

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
mysql-db6d920e****
实例 ID。
DBNodeIds
String[]
["mysql-c9b0dce8****-r2b33","mysql-c9b0dce8****-r3e7f"]
待删除的节点 ID 列表。
SwitchType
String
MaintainTime

执行时间,取值:

  • Immediate:立即切换(默认)。
  • MaintainTime:可维护时间段内进行切换。
  • SpecifiedTime:指定时间段内进行切换。

说明

取值为 SpecifiedTime 时,需要在参数 SpecifiedSwitchStartTime 和 SpecifiedSwitchEndTime 中设定时间段的起止时间。

RequestSource
String
EventType_Web

请求来源。取值:

  • EventType_Web:来自 Web。
  • EventType_OpenAPI:来自 Open API。
EstimateOnly
Boolean
true

是否发起变配评估。取值:

  • true:是。
  • false:否。默认值。

说明

如果发起,则按照其他字段确定的规格配置进行变配评估,实际不会执行变配动作。发起变配评估后,会返回 EstimationResult 参数,说明此次变配的影响。

SpecifiedSwitchStartTime
String
2024-12-25T14:00:00Z

指定时间段执行时时间段的起始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ

说明

SwitchType 取值为 SpecifiedTime 时,该参数为必填参数。

SpecifiedSwitchEndTime
String
2024-12-25T15:59:00Z

指定时间段执行时时间段的结束时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ

说明

  • SwitchType 取值为 SpecifiedTime 时,该参数为必填参数。
  • 指定时间段的最短时长为一小时五十九分钟。

返回参数

参数
类型
示例值
描述
InstanceId
String
mysql-db6d920e****
实例 ID。
OrderId
String
Order71220115095297****

订单 ID。

说明

当 EstimateOnly 取值为 true 时,该字段返回为空。

EstimationResult
Object
请参见返回示例。

按照当前配置变更后,预估会对实例产生的影响。

说明

当 EstimateOnly 取值为 false 或不为 EstimateOnly 传值时,不返回该字段。

示例

请求示例

POST /?Action=DeleteDBNodes&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-cf4f3ddc****",
    "DBNodeIds": [
        "mysql-cf4f3ddc****-r290e",
        "mysql-cf4f3ddc****-r3104",
        "mysql-cf4f3ddc****-r615f"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024112020341683DE8B8D60C055DE3413-6e37f0",
        "Action": "DeleteDBNodes",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mysql-cf4f3ddc****",
        "OrderId": "Order2180000010993392034"
    }
}

错误码

更多详情,请参见错误码