You need to enable JavaScript to run this app.
导航
DeleteHealthCheckTemplates
最近更新时间:2024.02.29 14:48:18首次发布时间:2022.05.20 22:34:18

API 说明

API 名称:DeleteHealthCheckTemplates。
API 域名:open.volcengineapi.com 。
API 描述:删除健康检查模板。单次批量删除模板上限为5个。

使用限制

节流限制:每秒最多提交 5 个 API 请求。

快速调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数

名称类型是否必选格式说明
Action
string
[a-zA-Z]+
API 名称,如 DeleteHealthCheckTemplates。
VersionstringYYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint900表示签名的有效时间,单位是秒,默认值是900。

请求正文

在使用该 API 提交请求时,请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例值
HealthCheckTemplateIds.N
List of String

待删除的健康检查模板ID,N是健康检查模板的序号。

  • - N:表示健康检查模板的序号,取值范围为1 ~ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplateIds.1=hctpl-123****432&HealthCheckTemplateIds.2=hctpl-123 ***** 432

响应正文

参数类型参数说明示例值
RequestId
String
请求ID。
20210816110638****2514606306AF947C

示例

请求示例

GET /?Action=DeleteHealthCheckTemplates&Version=2020-04-01&HealthCheckTemplateIds.1=hctpl-3ciw6t6efwef46c6rrtdhxu36 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "DeleteHealthCheckTemplates",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202108161106****22514606306AF947C",
    }
}

错误码

如果响应正文包含 Error 字段,则表示 API 请求失败。此处仅展示当前 API 的错误码,更多错误码请参见公共错误码

HTTP Code

错误码

错误信息

错误描述

400

LimitExceed.HealthCheckTemplate

You've reached the limit on the number of health check templates that you can operate at a time.

已达到单次可操作的健康检查模板的数量上限。

400InvalidIndexOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。

400

InvalidHealthCheckTemplateIds.Duplicated

The specified HealthCheckTemplateIds is duplicated.

指定的 HealthCheckTemplateIds 重复。

404InvalidHealthCheckTemplate.NotFoundThe specified HealthCheckTemplate does not exist.指定的健康检查模板不存在。