支持 dryRun。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
opensearch:WriteSummary | update |
|
| 无 |
请求语法
PUT /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/summaries HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
dryRun | boolean | 否 | 是否为空运行请求 | true |
appGroupIdentity | string | 是 | 应用名称 | “my_app_group_name” |
appId | integer | 是 | 版本号 | 10157886 |
body | array<object> | 否 | 请求体 | |
object | 否 | 请求体 | ||
field | string | 否 | 字段 | "title" |
len | integer | 否 | 片段长度 | 50 |
element | string | 否 | 飘红标签 | "em" |
ellipsis | string | 否 | 片段链接符 | "..." |
snippet | integer | 否 | 片段数量 | 1 |
请求体
字段 | 类型 | 是否必要 | 示例值 | 描述 |
---|---|---|---|---|
[] | Object | 是 | 摘要设置 参考: Summary 字段 | |
[].field | String | 是 | "title" | 字段 |
[].len | Integer | 是 | 50 | 片段长度 |
[].element | String | 是 | "em" | 飘红标签 |
[].ellipsis | String | 是 | "..." | 片段链接符 |
[].snippet | Integer | 是 | 1 | 片段数量 |
返回参数
示例
正常返回示例
JSON
格式
{
"result": true,
"requestId": "7A389E09-7964-5A2B-FE9D-F6CFA7162852"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-05-24 | OpenAPI 入参发生变更 | 查看变更详情 |