有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: cloudaudit.tencentcloudapi.com 。

查询跟踪集详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAudit。
Version String 公共参数,本接口取值:2019-03-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。
AuditName String 跟踪集名称

3. 输出参数

参数名称 类型 描述
IsEnableCmqNotify Integer 是否开启cmq消息通知。1:是,0:否。
示例值:1
ReadWriteAttribute Integer 管理事件读写属性,1:只读,2:只写,3:全部
示例值:1
KeyId String CMK的全局唯一标识符。
AuditStatus Integer 跟踪集状态,1:开启,0:停止。
示例值:1
AuditName String 跟踪集名称。
CosRegion String cos存储桶所在地域。
CmqQueueName String 队列名称。
KmsAlias String CMK别名。
KmsRegion String kms地域。
IsEnableKmsEncry Integer 是否开启kms加密。1:是,0:否。如果开启KMS加密,数据在投递到cos时,会将数据加密。
示例值:1
CosBucketName String cos存储桶名称。
CmqRegion String 队列所在地域。
LogFilePrefix String 日志前缀。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询跟踪集详情

查询跟踪集详情

输入示例

https://cloudaudit.tencentcloudapi.com/?Action=DescribeAudit
&AuditName=xxxxx_cloudaudit_2
&<公共请求参数>

输出示例

{
    "Response": {
        "AuditName": "xxxxx_cloudaudit_2",
        "CmqQueueName": "xxxxx-cloudaudit-2",
        "CmqRegion": "hk",
        "CosBucketName": "xxxxx-cloudaudit-2",
        "CosRegion": "ap-hongkong",
        "IsEnableCmqNotify": 1,
        "LogFilePrefix": "xxx2312",
        "ReadWriteAttribute": 1,
        "AuditStatus": 1,
        "KeyId": "xx",
        "IsEnableKmsEncry": 0,
        "KmsRegion": "xx",
        "KmsAlias": "xx",
        "RequestId": "e23ee347-d011-482a-83fa-12e7d318dd9f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.DescribeAuditError 查看跟踪集详情错误,请联系开发人员
ResourceNotFound.AuditNotExist 跟踪集不存在