All Products
Search
Document Center

API Gateway:SetApiProductsAuthorities

Last Updated:Mar 30, 2026

Grants permissions on API products to an 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

apigateway:SetApiProductsAuthorities

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AppId

integer

Yes

The application ID.

111385984

ApiProductIds

array

Yes

The API products.

string

No

The ID of the API product.

117b7a64a8b3f064eaa4a47ac62aac5e

AuthValidTime

string

No

The end time of the authorization validity period.,Use Greenwich Mean Time (GMT).(GMT), If this parameter is empty,,indicates permanent authorization..

2023-06-12T03:07:37Z

Description

string

No

The authorization description.

Description

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

2603F41E-77FC-59A3-840E-296578A9BDE0

Examples

Success response

JSON format

{
  "RequestId": "2603F41E-77FC-59A3-840E-296578A9BDE0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.