Register & Authenticate Apps via CreateApp API - API Gateway

Operation description

This operation is intended for API callers.
Each application has a key-value pair which is used for identity verification when you call an API.
An application must be authorized to call an API.
Each application has only one key-value pair, which can be reset if the pair is leaked.
A maximum of 1,000 applications can be created for each Alibaba Cloud account.
Allows up to 50 calls per second per account.

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

create

*App

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppName	string	Yes	The name of the application. The name must be 4 to 26 characters in length. The name can contain letters, digits, and underscores (_), and must start with a letter.	CreateAppTest
Description	string	No	The description of the application. The description can be up to 180 characters in length.	test
Tag	array<object>	No	The tag of objects that match the rule. You can specify multiple tags.	Key, Value
	object	No
Key	string	No	The key of the tag. Valid values of n: `[1, 20]`.	env
Value	string	No	The value of the tag. Valid values of n: `[1, 20]`. If the parameter has a value, you must specify a value for the tag key with the same N as tag.N.Key. Otherwise, an error is reported.	' '
AppKey	string	No	The key of the application that is used to make an API call.	60030986
AppSecret	string	No	The password of the application.	nzyNqFkRWB2uLw86
AppCode	string	No	The AppCode of the application.	3aaf905a0a1f4f0eabc6d891dfa08afc
Extend	string	No	The extended information.	110210264071

Response elements

Element	Type	Description	Example
	object
TagStatus	boolean	Indicates whether the tag exists. If the value is true, the tag exists. If the value is false, the tag does not exist.	false
RequestId	string	The ID of the request.	BA20890E-75C7-41BC-9C8B-73276B58F550
AppId	integer	The unique ID of the application.	20112314518278

Examples

Success response

JSON format

{
  "TagStatus": false,
  "RequestId": "BA20890E-75C7-41BC-9C8B-73276B58F550",
  "AppId": 20112314518278
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.