You need to enable JavaScript to run this app.
导航
EnableHealthLog
最近更新时间:2024.06.28 16:26:04首次发布时间:2022.07.07 14:48:15

请求说明

API 名称:EnableHealthLog。
API 域名:open.volcengineapi.com。
API 描述:开启健康检查日志收集,将 LB 绑定到 Topic 上。

使用限制

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

调试

URI 参数

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

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

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

请求参数

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

参数类型是否必选参数说明示例值
LoadBalancerId
String
ALB 实例 ID 。
alb-bp1b6c719dfa08ex****
TopicIdString绑定的 Topic ID 。topic-j12hf23gb***
ProjectIdStringTopic 对应的 Project 。project-sdfhaj***

返回参数

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

示例

请求示例

GET /?Action=EnableHealthLog&Version=2020-04-01&LoadBalancerId=alb-bp1b6c719dfa08ex****&ProjectId=pid-s87va8fa****&TopicId=tid-8fa78avd**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-test
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202108171522560****524314701095A5A",
        "Action": "EnableHealthLog",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-test"
    },
    "Result": {
        "RequestId": "202108171522560****524314701095A5A"
    }
}

错误码

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

HTTP Code错误码错误信息错误描述
400OperationDenied.AccountArrearsThe request on the specified resource is denied due to the account being in arrears status.因账号处于欠费状态,对于该资源的操作请求被拒绝。

400

InvalidTopic.InUse

The specified Topic is being used by the access log. The health log and the access log can not be delivered to the same TLS at the same time.

指定的日志主题正在被访问日志使用。健康检查日志和访问日志无法投递到同一个 TLS 主题中。

400OperationFailed.QueryIAMThe request on the specified resource failed due to the query on IAM failed.因请求 IAM 失败,对于该资源的操作请求失败。

400

OperationFailed.QueryTls

The request on the specified resource failed due to the query on TLS failed.

因请求 TLS 失败,对于该资源的操作请求失败。

400

InvalidLoadBalancer.InvalidStatus

The specified LoadBalancer is not in the correct status for the request.

指定的 ALB 实例所处状态无法响应该请求。

404

InvalidLoadBalancer.NotFound

The specified LoadBalancer does not exist.

指定的 ALB 实例不存在。

404InvalidTopic.NotFoundThe specified Topic does not exist.指定的日志主题不存在。

404

InvalidProject.NotFound

The specified Project does not exist.

指定的日志项目不存在。

409

InvalidHealthLog.Conflict

The specified HealthLog of the LoadBalancer already exists.

指定的 ALB 实例已开启健康检查日志采集。