UpdateSummaries - OpenSearch - Alibaba Cloud Documentation Center

Updates summaries. A dry run is supported.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:WriteSummary	update	App acs:opensearch:{#regionId}:{#accountId}:apps/{#AppId}	none	none

Request syntax

PUT /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/summaries HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether the request is a dry run.	true
appGroupIdentity	string	Yes	The name of the application.	“my_app_group_name”
appId	integer	Yes	The version number of the application.	10157886
body	array<object>	No	The request body.
	object	No	The request body.
field	string	No	The field.	"title"
len	integer	No	The length of a segment.	50
element	string	No	The HTML tag that is used to highlight terms in red.	"em"
ellipsis	string	No	The connector that is used to connect segments.	"..."
snippet	integer	No	The number of segments.	1

Request body

Field	Type	Required	Example	Description
[]	Object	Yes		The summary settings.For more information, see Summary .
[].field	String	Yes	"title"	The field.
[].len	Integer	Yes	50	The length of a segment.
[].element	String	Yes	"em"	The HTML tag that is used to highlight terms in red.
[].ellipsis	String	Yes	"..."	The connector that is used to connect segments.
[].snippet	Integer	Yes	1	The number of segments.

Response parameters

Parameter	Type	Description	Example
	object
result	boolean	Indicates whether the request was successful.	true
requestId	string	The request ID.	7A389E09-7964-5A2B-FE9D-F6CFA7162852

Examples

Sample success responses

JSONformat

{
  "result": true,
  "requestId": "7A389E09-7964-5A2B-FE9D-F6CFA7162852"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-05-24	The request parameters of the API has changed	View Change Details