调用DescribeComponentIndex,查看Elasticsearch的组合模板详情。
详细信息请参见通过OpenStore实现海量数据存储。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /openapi/instances/{InstanceId}/component-index/{name} HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-tl329rbpc0001**** |
实例ID。 |
name | String | Path | 否 | template |
组合模板名称。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC47D9 |
请求ID。 |
Result | Object |
返回结果。 |
|
template | Object |
模板信息。 |
|
aliases | Map | {} |
模板别名配置。 |
mappings | Map | { "properties": { "@timestamp": { "type": "date" } } } |
模板mappings配置。 |
settings | Map | { "index.number_of_replicas": 0 } |
模板settings配置。 |
_meta | Map | { "description": "set number of shards to one" } |
元数据,用于存储备注等信息。 |
示例
请求示例
GET /openapi/instances/es-cn-tl329rbpc0001****/component-index/template HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC47D9",
"Result" : {
"template" : {
"settings" : {
"index.number_of_replicas" : 0
},
"mappings" : {
"properties" : {
"@timestamp" : {
"type" : "date"
}
}
},
"aliases" : { }
},
"_meta" : {
"description" : "set number of shards to one"
}
}
}
错误码
访问错误中心查看更多错误码。