设置指定 OpenSearch 应用版本摘要,支持 dryRun
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
PUT /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId]/summaries HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
appGroupIdentity | String | Path | 是 | “my_app_group_name” |
应用名称 |
appId | Integer | Path | 是 | 10157886 |
版本号 |
dryRun | Boolean | Query | 否 | true |
是否为空运行请求 |
字段 |
类型 |
是否必要 |
示例值 |
描述 |
---|---|---|---|---|
[] |
Object |
是 |
摘要设置 参考:Summary 字段 |
|
[].field |
String |
是 |
"title" |
字段 |
[].len |
Integer |
是 |
50 |
片段长度 |
[].element |
String |
是 |
"em" |
飘红标签 |
[].ellipsis |
String |
是 |
"..." |
片段链接符 |
[].snippet |
Integer |
是 |
1 |
片段数量 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
requestId | String | 7A389E09-7964-5A2B-FE9D-F6CFA7162852 |
请求ID |
result | Boolean | true |
是否成功 |
示例
请求示例
PUT /v4/openapi/app-groups/os_function_test_v1/apps/100299910/summaries?dryRun=true
[{
"field": "title",
"len": 50,
"element": "em",
"ellipsis": "...",
"snippet": 1
}]
正常返回示例
XML
格式
<result>true</result>
<requestId>7A389E09-7964-5A2B-FE9D-F6CFA7162852</requestId>
JSON
格式
{
"result": true,
"requestId": "7A389E09-7964-5A2B-FE9D-F6CFA7162852"
}
错误码
访问错误中心查看更多错误码。