API 名称:ModifyHealthCheckTemplatesAttributes。
API 域名:open.volcengineapi.com 。
API 描述:修改健康检查模板属性。单次批量修改模板上限为5个。
节流限制:每秒最多提交 10 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数。
名称 | 类型 | 是否必选 | 格式 | 说明 |
---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称,如 ModifyHealthCheckTemplatesAttributes。 |
Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
X-Expires | int | 否 | 900 | 表示签名的有效时间,单位是秒,默认值是900。 |
在使用该 API 提交请求时,请求参数中可以包含的参数如下。
参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
---|---|---|---|---|
HealthCheckTemplates | Array | 是 | 具体请参见下表 HealthCheckTemplates 。 | - |
HealthCheckTemplates
参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
---|---|---|---|---|
HealthCheckTemplates.N.HealthCheckTemplateId | List of Struct | 是 | 健康检查模板ID。
| HealthCheckTemplates.1.HealthCheckTemplateId=hctpl-123****765&HealthCheckTemplates.2.HealthCheckTemplateId=hctpl-iuytrfv |
HealthCheckTemplates.N.HealthCheckTemplateName | List of Struct | 否 | 健康检查模板的名字,要求如下:
| HealthCheckTemplates.1.HealthCheckTemplateName=test1&HealthCheckTemplates.2.HealthCheckTemplateName=test2 |
HealthCheckTemplates.N.Description | List of Struct | 否 | 健康检查描述,要求如下:
| HealthCheckTemplates.1.Description=test1&HealthCheckTemplates.2.Description=test2 |
HealthCheckTemplates.N.HealthCheckInterval | List of Struct | 否 | 执行健康检查的时间间隔,默认为2,取值1-300s。
| HealthCheckTemplates.1.HealthCheckInterval=2&HealthCheckTemplates.2.HealthCheckInterval=3 |
HealthCheckTemplates.N.HealthCheckTimeout | List of Struct | 否 | 健康检查的响应超时时间,默认为2,取值1-60s 。
| HealthCheckTemplates.1.HealthCheckTimeout=2&HealthCheckTemplates.2.HealthCheckTimeout=3 |
HealthCheckTemplates.N.HealthyThreshold | List of Struct | 否 | 健康检查的健康阈值,默认为3,取值2-10次。
| HealthCheckTemplates.1.HealthyThreshold=2&HealthCheckTemplates.2.HealthyThreshold=3 |
HealthCheckTemplates.N.UnhealthyThreshold | List of Struct | 否 | 健康检查的不健康阈值,默认为3,取值2-10次。
| HealthCheckTemplates.1.UnhealthyThreshold=2&HealthCheckTemplates.2.UnhealthyThreshold=3 |
HealthCheckTemplates.N.HealthCheckMethod | List of Struct | 否 | 健康检查的方法,只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。支持GET和HEAD。
| HealthCheckTemplates.1.HealthCheckMethod=GET&HealthCheckTemplates.2.HealthCheckMethod=HEAD |
HealthCheckTemplates.N.HealthCheckDomain | List of Struct | 否 | 健康检查的域名,只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。要求如下:
| HealthCheckTemplates.1.HealthCheckDomain=a.com&HealthCheckTemplates.2.HealthCheckDomain=b.com |
HealthCheckTemplates.N.HealthCheckURI | List of Struct | 否 | 健康检查的路径,只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。要求如下:
| HealthCheckTemplates.1.HealthCheckURI=&HealthCheckTemplates.2.HealthCheckURI=abc |
HealthCheckTemplates.N.HealthCheckHttpCode | List of Struct | 否 |
| HealthCheckTemplates.1.HealthCheckHttpCode=http_2xx&HealthCheckTemplates.2.HealthCheckHttpCode=http_3xx,http_4xx |
HealthCheckTemplates.N.HealthCheckProtocol | List of Struct | 否 | 健康检查的协议,当前支持HTTP、TCP。
| HealthCheckTemplates.1.HealthCheckProtocol=HTTP&HealthCheckTemplates.2.HealthCheckProtocol=HTTP |
HealthCheckTemplates.N.HealthCheckHttpVersion | List of Struct | 否 | 健康检查HTTP协议版本,只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。取值:
| HTTP1.1 |
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
RequestId | String | 请求ID。 | 20210816110638****2514606306AF947C |
GET /?Action=ModifyHealthCheckTemplatesAttributes&HealthCheckTemplates.1.Description=test&Version=2020-04-01&HealthCheckTemplates.1.HealthCheckTemplateId=hctpl-123*****876&HealthCheckTemplates.1.HealthCheckTemplateName=test&HealthCheckTemplates.1.HealthCheckHttpCode="http_2xx,http_3xx" HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: alb
{ "ResponseMetadata": { "RequestId": "20210816110638****2514606306AF947C", "Action": "ModifyHealthCheckTemplatesAttributes", "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. | 已达到单次可操作的健康检查模板的数量上限。 |
400 | InvalidIndexOrder.Malformed | The specified index order is malformed. | 指定的索引顺序参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckTemplateName.Malformed | The specified HealthCheckTemplates.HealthCheckTemplateName is malformed. | 指定的 HealthCheckTemplates.HealthCheckTemplateName 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.Description.Malformed | The specified HealthCheckTemplates.Description is malformed. | 指定的 HealthCheckTemplates.Description 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckProtocol.Malformed | The specified HealthCheckTemplates.HealthCheckProtocol is malformed. | 指定的 HealthCheckTemplates.HealthCheckProtocol 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckMethod.Malformed | The specified HealthCheckTemplates.HealthCheckMethod is malformed. | 指定的 HealthCheckTemplates.HealthCheckMethod 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckDomain.Malformed | The specified HealthCheckTemplates.HealthCheckDomain is malformed. | 指定的 HealthCheckTemplates.HealthCheckDomain 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckURI.Malformed | The specified HealthCheckTemplates.HealthCheckURI is malformed. | 指定的 HealthCheckTemplates.HealthCheckURI 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckInterval.Malformed | The specified HealthCheckTemplates.HealthCheckInterval is malformed. | 指定的 HealthCheckTemplates.HealthCheckInterval 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckTimeout.Malformed | The specified HealthCheckTemplates.HealthCheckTimeout is malformed. | 指定的 HealthCheckTemplates.HealthCheckTimeout 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthyThreshold.Malformed | The specified HealthCheckTemplates.HealthyThreshold is malformed. | 指定的 HealthCheckTemplates.HealthyThreshold 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.UnhealthyThreshold.Malformed | The specified HealthCheckTemplates.UnhealthyThreshold is malformed. | 指定的 HealthCheckTemplates.UnhealthyThreshold 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckHttpCode.Malformed | The specified HealthCheckTemplates.HealthCheckHttpCode is malformed. | 指定的 HealthCheckTemplates.HealthCheckHttpCode 参数格式不合法。 |
400 | InvalidHealthCheckTemplates.HealthCheckHttpVersion.Malformed | The specified HealthCheckTemplates.HealthCheckHttpVersion is malformed. | 指定的 HealthCheckTemplates.HealthCheckHttpVersion 参数格式不合法。 |
400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'HealthCheckTemplates.HealthCheckDomain'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: HealthCheckTemplates.HealthCheckDomain。 |
404 | InvalidHealthCheckTemplate.NotFound | The specified HealthCheckTemplate does not exist. | 指定的健康检查模板不存在。 |