Batch-Authorize Apps via SetAppsAuthorities - API Gateway - Alibaba Cloud - API Gateway

Operation description

This operation is intended for API providers and callers.
API providers can authorize all applications to call their APIs.
API callers can authorize their own applications to call the APIs that they have purchased.

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

apigateway:SetAppsAuthorities

update

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

*App

acs:apigateway:{#regionId}:{#accountId}:app/{#AppIds}

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the API group. This ID is generated by the system and globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
ApiId	string	Yes	The ID of the API. This ID is generated by the system and globally unique.	baacc592e63a4cb6a41920d9d3f91f38
StageName	string	Yes	The name of the runtime environment. Valid values: RELEASE TEST	TEST
AppIds	string	Yes	The IDs of applications. Separate multiple application IDs with commas (,). A maximum of 100 applications IDs can be entered.	2386789,3389798
Description	string	No	The description of the authorization.	Queries weather information by region name.
AuthValidTime	string	No	The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.	Fri,05Oct201816:00:00GMT

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D6E46F10-F26C-4AA0-BB69-FE2743D9AE62

Examples

Success response

JSON format

{
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.