1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(CreateCLSDelivery)用于创建日志投递。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCLSDelivery。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
InstanceId | 是 | String | 实例id 示例值:cynosdbmysql-ins-ifq10f11 |
CLSInfoList.N | 是 | Array of CLSInfo | 日志投递配置 示例值:[{"TopicId":"38b86342-7cb0-4776-9ebd-ff1830035da1","TopicOperation":"reuse","GroupId":"17de6e2a-efd0-4fc2-ba2e-8845bd4f9895","Region":"ap-guangzhou","GroupOperation":"reuse"}] |
LogType | 否 | String | 日志类型 示例值:slow |
IsInMaintainPeriod | 否 | String | 是否维护时间运行 示例值:no |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 异步任务id 示例值:148728 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建日志投递
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCLSDelivery
<公共请求参数>
{
"InstanceId": "cynosdbmysql-ins-o971o62r",
"CLSInfoList": [
{
"TopicId": "38b86342-7cb0-4776-9ebd-ff1830035da1",
"TopicOperation": "reuse",
"GroupId": "17de6e2a-efd0-4fc2-ba2e-8845bd4f9895",
"Region": "ap-guangzhou",
"GroupOperation": "reuse"
}
]
}
输出示例
{
"Response": {
"TaskId": 148728,
"RequestId": "347698da-03e4-4078-8d96-9a8b219c01a5"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
ResourceNotFound.ResourceError | 参数对应资源不存在。 |
UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |