CreateApp_应用版本_管控API_开发指南

描述

创建一个 opensearch 应用版本

若已存在同名标准版应用，则创建新版本；
在新建版本情况下，autoSwitch 和 realtimeShared 也是必填的；
在新建版本情况下，quota 是自动从上一个版本继承的；
在新建版本情况下，修改 quota 是无效的。

方法

POST

URI

/v4/openapi/app-groups/[appGroupIdentity]/apps?dryRun=true|false

请求参数

路径参数

字段	类型	是否必要	示例值	描述
appGroupIdentity	String	是	“my_app_group_name”	应用名称

查询参数

字段	类型	是否必要	示例值	描述
dryRun	Boolean	否	true	是否为空运行请求

请求体

字段	类型	是否必要	示例值	描述
type	String	是	“standard”	应用类型 - standard 标准版 - enhanced 高级版
schema	Object	是		应用版本结构参考：Schema
fetchFields	Array	是	[“id”, “name”]	默认展示字段
realtimeShared	Boolean	否	false	是否共享实时流
autoSwitch	Boolean	否	false	是否自动切上线
description	String	否	“demo”	备注
quota	Object	否		版本配额信息参考：Quota
dataSources[]	Object	否		数据源详情参考：DataSource
firstRanks[]	Object	否		粗排表达式配置详情参考：FirstRank
secondRanks[]	Object	否		精排表达式配置详情参考：SecondRank
queryProcessors[]	Object	否		查询意图理解规则配置详情参考：QueryProcessor
summaries[]	Object	否		搜索结果摘要设置参考：Summary

返回参数

字段	类型	描述
requestId	String	请求ID
result	Object	版本信息参考：App

示例

请求示例

POST /v4/openapi/app-groups/os_function_test_v1/apps?dryRun=false

{
    "type": "enhanced",
    "schema": {
        "indexes": {
            "searchFields": {
                "id": {
                    "fields": [
                        "id"
                    ]
                },
                "default": {
                    "fields": [
                        "title"
                    ],
                    "analyzer": "chn_standard"
                },
                "cate_name": {
                    "fields": [
                        "cate_name"
                    ]
                }
            },
            "filterFields": [
                "id",
                "buy",
                "cate_id",
                "cate_name"
            ]
        },
        "tables": {
            "main": {
                "name": "main",
                "fields": {
                    "id": {
                        "name": "id",
                        "type": "LITERAL",
                        "primaryKey": true
                    },
                    "title": {
                        "name": "title",
                        "type": "TEXT",
                        "primaryKey": false
                    },
                    "buy": {
                        "name": "buy",
                        "type": "INT",
                        "primaryKey": false
                    },
                    "cate_id": {
                        "name": "cate_id",
                        "type": "INT",
                        "primaryKey": false
                    },
                    "cate_name": {
                        "name": "cate_name",
                        "type": "LITERAL",
                        "primaryKey": false
                    }
                },
                "primaryTable": true
            }
        },
        "routeField": ""
    },
    "dataSources": [{
        "tableName": "opensearch_table",
        "type": "rds",
        "fields": [{
                "id": "id"
            },
            {
                "title": "title"
            }
        ],
        "plugins": {
            "caption": {
                "name": "HTMLTagRemover",
                "parameters": {}
            },
            "content": {
                "name": "HTMLTagRemover",
                "parameters": {}
            }
        },
        "keyField": "id",
        "parameters": {
            "filter": "",
            "instanceId": "rm-bp1z7c93815m2256j",
            "dbName": "opensearch",
            "dbTableName": "opensearch_table",
            "dbUser": "test_12345",
            "dbPassword": "Test123456!",
            "autoSync": "true"
        }
    }],
    "firstRanks": [{
        "name": "first_rank_lsh_1",
        "description": "",
        "active": true,
        "meta": [{
                "attribute": "static_bm25()",
                "arg": "",
                "weight": 10
            },
            {
                "attribute": "exact_match_boost()",
                "arg": "",
                "weight": 20
            },
            {
                "attribute": "buy",
                "arg": "",
                "weight": 30
            }
        ]
    }],
    "secondRanks": [{
        "name": "lsh_second_1",
        "meta": "cate_id > 0 and cate_id < 1000",
        "active": true,
        "description": ""
    }],
    "summary": [{
        "field": "title",
        "len": 50,
        "element": "em",
        "ellipsis": "...",
        "snippet": 1
    }],
    "fetchFields": [
        "id",
        "title",
        "buy",
        "cate_id",
        "cate_name"
    ],
    "queryProcessors": [{
        "name": "sum_lsh_test_1",
        "domain": "GENERAL",
        "processors": [{
                "name": "stop_word",
                "useSystemDictionary": true,
                "interventionDictionary": ""
            },
            {
                "name": "spell_check",
                "useSystemDictionary": true,
                "interventionDictionary": ""
            },
            {
                "name": "term_weighting",
                "useSystemDictionary": true,
                "interventionDictionary": ""
            },
            {
                "name": "synonym",
                "useSystemDictionary": true,
                "interventionDictionary": ""
            }
        ],
        "indexes": [
            "default"
        ],
        "active": true,
        "id": "887512"
    }],
    "quota": {
        "computeResource": 20,
        "docSize": 1,
        "spec": "opensearch.share.common"
    }
}

返回示例

正确返回

{
    "requestId": "8664F6B7-9DD8-096A-FA3E-EBEE199EB94C",
    "result": {
        "id": "123456",
        "description": "",
        "status": "initializing",
        "fetchFields": [
            "id",
            "title",
            "buy",
            "cate_id",
            "cate_name"
        ],
        "type": "enhanced",
        "schema": {
            "tables": {
                "main": {
                    "name": "main",
                    "primaryTable": true,
                    "fields": {
                        "id": {
                            "name": "id",
                            "type": "LITERAL",
                            "primaryKey": true
                        },
                        "title": {
                            "name": "title",
                            "type": "TEXT",
                            "primaryKey": false
                        },
                        "buy": {
                            "name": "buy",
                            "type": "INT",
                            "primaryKey": false
                        },
                        "cate_id": {
                            "name": "cate_id",
                            "type": "INT",
                            "primaryKey": false
                        },
                        "cate_name": {
                            "name": "cate_name",
                            "type": "LITERAL",
                            "primaryKey": false
                        }
                    }
                }
            },
            "indexes": {
                "searchFields": {
                    "id": {
                        "fields": [
                            "id"
                        ]
                    },
                    "default": {
                        "fields": [
                            "title"
                        ],
                        "analyzer": "chn_standard"
                    },
                    "cate_name": {
                        "fields": [
                            "cate_name"
                        ]
                    }
                },
                "filterFields": [
                    "id",
                    "buy",
                    "cate_id",
                    "cate_name"
                ]
            }
        },
        "algoDeploymentId": 0,
        "created": 0,
        "progressPercent": 0
    }
}

错误返回
参考：响应结构