服务网格获取AccessLog配置-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tcm.tencentcloudapi.com 。

获取AccessLog配置

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAccessLogConfig。
Version	是	String	公共参数，本接口取值：2021-04-13。
Region	是	String	公共参数，详见产品支持的地域列表。
MeshId	是	String	mesh名字

3. 输出参数

参数名称	类型	描述
File	String	访问日志输出路径。默认 /dev/stdout 示例值：xxx
Format	String	访问日志的格式。示例值：%REQ(Method)
Encoding	String	访问日志输出编码，可取值为 "TEXT" 或 "JSON"，默认 TEXT" 示例值：TEXT
SelectedRange	SelectedRange	选中的范围注意：此字段可能返回 null，表示取不到有效值。
Template	String	采用的模板，可取值为"istio" 或 "trace"，默认为"istio" 示例值：istio
CLS	CLS	腾讯云日志服务相关参数
Address	String	GRPC第三方服务器地址
EnableServer	Boolean	是否启用GRPC第三方服务器示例值：true
EnableStdout	Boolean	是否启用标准输出示例值：true
Enable	Boolean	是否启用访问日志采集注意：此字段可能返回 null，表示取不到有效值。示例值：true
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取Mesh访问日志配置

输入示例

POST / HTTP/1.1
Host: tcm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccessLogConfig
<公共请求参数>

{
    "MeshId": "\"mesh-test\""
}

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "Enable": true,
        "File": "xxx",
        "Format": "%REQ(Method)",
        "Encoding": "TEXT",
        "EnableStdout": true,
        "EnableServer": true,
        "Address": "xx",
        "SelectedRange": {
            "All": true
        },
        "Template": "xx",
        "CLS": {
            "LogSet": "xx",
            "Topic": "xx",
            "Enable": true,
            "NeedDelete": true
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.RBACForbidden	Cluster RBAC权限限制。
InternalError	内部错误。
ResourceNotFound	资源不存在。