ListQuotaReviewTasks - OpenSearch - Alibaba Cloud Documentation Center

Lists the quota approval tickets for a specified OpenSearch application.

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:DescribeApp

*AppGroup

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

None

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/quota-review-tasks HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application group.	"my_app_name"

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	The page number. The default value is 1.	1
pageSize	integer	No	The number of entries to return on each page. The default value is 10.	10

Sample request:

GET /v4/openapi/app-groups/demo/quota-review-tasks

Response elements

Element	Type	Description	Example
	object	The response object.
totalCount	integer	The total number of entries.	500
requestId	string	The request ID.	"3351A21F-705B-508C-9450-DA65A681547F"
result	array<object>	The information about the approval tickets. For more information, see QuotaReviewTask.	[]
	object	The result object.	{}
oldDocSize	integer	The original storage capacity.	900
pending	boolean	Indicates whether the task is pending.	false
memo	string	The remarks.	null
approved	boolean	Indicates whether the task is approved.	true
oldSpec	string	The original specifications of the application.	"opensearch.private.common"
oldComputeResource	integer	The original computing resource.	500
appGroupType	string	The application type.	"standard"
available	boolean	Indicates whether the resource is active.	true
gmtCreate	string	The time when the task was created.	"2020-04-08T08:29:45+0000"
newSocSize	integer	The target storage capacity.	1100
id	integer	The ticket ID.	142
appGroupId	integer	The application ID.	120123456
newComputeResource	integer	The target computing resource.	6000
appGroupName	string	The application name.	"td_test_os"
gmtModified	string	The time of the last modification.	"2020-04-08T08:36:36+0000"
newSpec	string	The new application specifications.	"opensearch.private.common"

Sample response:

{
    "id": 142,
    "appGroupId": 120577535,
    "appGroupName": "td_trade_order_os",
    "appGroupType": "standard",
    "oldSpec": "opensearch.private.common",
    "oldComputeResource": 500,
    "oldDocSize": 900,
    "newSpec": "opensearch.private.common",
    "newComputeResource": 6000,
    "newSocSize": 1100,
    "memo": null,
    "available": true,
    "pending": false,
    "approved": true,
    "gmtCreate": "2020-04-08T08:29:45+0000",
    "gmtModified": "2020-04-08T08:36:36+0000"
}

Examples

Success response

JSON format

{
  "totalCount": 500,
  "requestId": "\"3351A21F-705B-508C-9450-DA65A681547F\"",
  "result": [
    {
      "oldDocSize": 900,
      "pending": false,
      "memo": "null",
      "approved": true,
      "oldSpec": "\"opensearch.private.common\"",
      "oldComputeResource": 500,
      "appGroupType": "\"standard\"",
      "available": true,
      "gmtCreate": "\"2020-04-08T08:29:45+0000\"",
      "newSocSize": 1100,
      "id": 142,
      "appGroupId": 120123456,
      "newComputeResource": 6000,
      "appGroupName": "\"td_test_os\"",
      "gmtModified": "\"2020-04-08T08:36:36+0000\"",
      "newSpec": "\"opensearch.private.common\""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.