1. 接口描述
接口请求域名： cls.tencentcloudapi.com 。
本接口用于创建投递SCF任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDeliverCloudFunction。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TopicId | 是 | String | 投递规则属于的TopicId。 - 通过 获取日志主题列表 获取日志主题Id。 - 通过 创建日志主题 获取日志主题Id。 示例值：871710c5-35cd-4d1e-8e79-2fa92c35d612 |
| FunctionName | 是 | String | 投递的云函数名字。仅支持事件函数 （函数类型选型） 通过 获取函数列表 获取函数信息。 示例值：functionName1 |
| Namespace | 是 | String | 命名空间。参考 命名空间管理 - 通过 列出命名空间列表 获取Name。 示例值：ns1 |
| Qualifier | 是 | String | 函数版本。 - 通过 查询函数版本 获取函数版本。 示例值：$LATEST |
| Timeout | 否 | Integer | 投递最长等待时间，单位：秒。 默认：60 示例值：60 |
| MaxMsgNum | 否 | Integer | 投递最大消息数。默认为100。支持范围[1,10000] 示例值：100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建投递SCF任务-成功
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeliverCloudFunction
<公共请求参数>
{
"TopicId": "7953cd3d-993f-4813-822d-1dc65f5ba111",
"FunctionName": "test-client-log-handler",
"Namespace": "default",
"Timeout": 60,
"Qualifier": "$LATEST"
}输出示例
{
"Response": {
"RequestId": "01fd5bcc-d7d4-4edb-9ff5-7ecfc305b831"
}
}示例2 创建投递SCF任务-失败
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeliverCloudFunction
<公共请求参数>
{
"TopicId": "923527bf-0728-4114-88a8-5898c0f527ac",
"FunctionName": "functionName1",
"Namespace": "ns1",
"Qualifier": "$LATEST",
"Timeout": 60,
"MaxMsgNum": 100
}输出示例
{
"Response": {
"Error": {
"Code": "ResourceNotFound.TopicNotExist",
"Message": "topic not exist RequestId:[341023a0-26d7-4ce6-8f8f-72fc34661335]"
},
"RequestId": "341023a0-26d7-4ce6-8f8f-72fc34661335"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| UnsupportedOperation | 操作不支持。 |
