SuspendProcesses - 挂起伸缩组流程--弹性伸缩-火山引擎

文档中心

立即注册

导航

SuspendProcesses - 挂起伸缩组流程

最近更新时间：2024.05.16 10:34:06首次发布时间：2024.05.16 10:34:06

暂停伸缩组中的指定流程，关于暂停/恢复伸缩组流程。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	SuspendProcesses	要执行的操作，取值：SuspendProcesses。
Version	String	是	2020-01-01	API的版本，取值：2020-01-01。
ScalingGroupId	String	是	scg-ybmssdnnhn5pkgyd****	伸缩组ID。您可以调用DescribeScalingGroups 接口查询伸缩组ID。
Processes.N	Array of String	是	ScaleIn	需要暂停的流程类型。参数 - N：表示流程类型的序号，取值1 ~ 5。多个事件通知类型之间用&分隔。取值： ScaleIn：缩容流程。 ScaleOut：扩容流程。 HealthCheck：健康检查。 AlarmNotification：报警任务。 ScheduledAction：定时任务。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=SuspendProcesses&Processes.1=ScaleIn&ScalingGroupId=scg-ybmssdnnhn5pkgyd%2A%2A%2A%2A&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T093118Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024050717292117409705701383451B",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

您可访问公共错误码，获取更多错误码信息。