All Products
Search
Document Center

API Gateway:SetAppsAuthorities

Last Updated:Mar 01, 2024

Grants access permissions on a specified API to multiple applications.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:SetAppsAuthoritiesWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringNo

The ID of the API group. This ID is generated by the system and globally unique.

523e8dc7bbe04613b5b1d726c2a7889d
ApiIdstringYes

The ID of the API. This ID is generated by the system and globally unique.

baacc592e63a4cb6a41920d9d3f91f38
StageNamestringYes

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
TEST
AppIdsstringYes

The API ID for the specified operation. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.

2386789,3389798
DescriptionstringNo

The description of the authorization.

Queries weather based on the region name
AuthValidTimestringNo

The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.

Fri,05Oct201816:00:00GMT

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

D6E46F10-F26C-4AA0-BB69-FE2743D9AE62

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history