UpdateSummaries - OpenSearch - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:WriteSummary

update

*App

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	“my_app_group_name”
appId	integer	Yes	The version number of the application.	10157886

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether the request is a dry run.	true
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.
[].ellipsis	String	Yes	"..."	The connector that is used to connect segments.
[].snippet	Integer	Yes	1	The number of segments.

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.