1. 接口描述
接口请求域名: goosefs.tencentcloudapi.com 。
GooseFS 预热相关接口,用于下发,列出,查询,修改预热任务。用于元数据预热、数据预热场景。 注意,该接口需要 GooseFS 集群版本 ≥ 1.5.1。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateLoadTask。 |
| Version | 是 | String | 公共参数,本接口取值:2022-05-19。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore, eu-frankfurt, na-ashburn 。 |
| ClusterId | 是 | String | 集群 ID 示例值:g_cvm_hi052k4l |
| LoadTaskCreationAttrs | 是 | LoadTaskCreationAttrs | 创建预热任务参数 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 预热任务 ID 示例值:baae4888-62e5-4027-bd56-070e82b2a584 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建预热任务
输入示例
POST / HTTP/1.1
Host: goosefs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadTask
<公共请求参数>
{
"ClusterId": "g_cvm_hi052k4l",
"LoadTaskCreationAttrs": {
"TaskType": "DistributedLoad",
"Priority": 666,
"MetadataLoadAttrs": {
"LoadType": "LoadByPath",
"SkipIfExists": false,
"LoadByPath": "/goosefs_path/"
},
"DistributedLoadAttrs": {
"LoadType": "LoadByPath",
"LoadByPath": "/goosefs_path/",
"Replica": "SingleReplica"
}
}
}
输出示例
{
"Response": {
"TaskId": "baae4888-62e5-4027-bd56-070e82b2a584",
"RequestId": "0174dedd-9c61-47aa-9ee9-1c5f901f8262"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |