EnableTLSAccessLog--应用型负载均衡-火山引擎

文档中心

立即注册

导航

EnableTLSAccessLog

最近更新时间：2024.06.28 16:26:05首次发布时间：2023.02.06 17:13:03

请求说明

API 名称：EnableTLSAccessLog。
API 域名：open.volcengineapi.com。
API 描述：开启访问日志投递TLS，将LB绑定到Topic上。

使用限制

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

调试

API Explorer

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

去调试

URI 参数

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

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

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

请求参数

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

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

返回参数

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

示例

请求示例

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

返回示例

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

错误码

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

HTTP Code	错误码	错误信息	错误描述
400	OperationDenied.AccountArrears	The 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 health log. The health log and the access log can not be delivered to the same TLS at the same time.	指定的日志主题正在被健康检查日志使用。健康检查日志和访问日志无法投递到同一个 TLS 主题中。
400	OperationFailed.QueryIAM	The 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 实例不存在。
404	InvalidTopic.NotFound	The specified Topic does not exist.	指定的日志主题不存在。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的日志项目不存在。