一、1. 接口描述
检查cos迁移索引元数据
默认接口请求频率限制：20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：CheckMigrateIndexMetaData。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn 。 |
| ServerlessId | 是 | String | 索引 id示例值：index-faefaefg |
| Snapshot | 是 | String | 快照名示例值：snapshot |
| CosBucket | 否 | String | Cos桶名示例值：user-cos-name |
| BasePath | 否 | String | BasePath路径示例值：dir/ |
| ClusterInstanceId | 否 | String | 云上集群名示例值：es-fwajfwii |
| CommonIndexArr.N | 否 | Array of String | 普通索引名列表示例值：["index1", "index2"] |
| DataStreamArr.N | 否 | Array of String | 自治索引名列表示例值：["index1", "index2"] |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| MappingTimeFieldCheckFailedIndexArr | Array of String | 不存在于目标索引时间字段相同的字段示例值：[""] |
| MappingTimeTypeCheckFailedIndexArr | Array of String | @timestamp不为date类型，与目标索引时间字段冲突示例值：[""] |
| SettingCheckFailedIndexArr | Array of String | 索引的创建时间不在 serverless的存储周期内示例值：[""] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckMigrateIndexMetaData
<公共请求参数>
{
"CosBucket": "user-cos",
"BasePath": "dir/",
"ServerlessId": "index-feafagg",
"Snapshot": "snapshot",
"ClusterInstanceId": "es-feafegg",
"CommonIndexArr": [
"index"
],
"DataStreamArr": [
"index"
]
}
五、输出示例
{
"Response": {
"MappingTimeFieldCheckFailedIndexArr": [
"index"
],
"MappingTimeTypeCheckFailedIndexArr": [
"index"
],
"SettingCheckFailedIndexArr": [
"index"
],
"RequestId": "40f4f780-9969-42f9-8bd9-ccf0d1f2591a"
}
}
六、腾讯云 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
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。