All Products
Search

This Product

    API Gateway:CreateApp

    Document Center

    API Gateway:CreateApp

    Last Updated:Apr 01, 2024

    Creates an app for 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.
    • You can call this operation up to 50 times per second per account.

    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:CreateAppWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AppNamestringYes

    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
    DescriptionstringNo

    The description of the application. The description can be up to 180 characters in length.

    		test
    Tagobject []No

    The tag of objects that match the rule. You can specify multiple tags.

    		Key， Value
    KeystringNo

    The key of the tag.

    Valid values of n: [1, 20].

    		env
    ValuestringNo

    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.

    		' '
    AppKeystringNo

    The key of the application that is used to make an API call.

    		60030986
    AppSecretstringNo

    The password of the application.

    		nzyNqFkRWB2uLw86
    AppCodestringNo

    The AppCode of the application.

    		3aaf905a0a1f4f0eabc6d891dfa08afc
    ExtendstringNo

    The extended information.

    		110210264071

    Response parameters

    ParameterTypeDescriptionExample
    object
    TagStatusboolean

    Indicates whether the tag exists. If the value is true, the tag exists. If the value is false, the tag does not exist.

    		false
    RequestIdstring

    The ID of the request.

    		BA20890E-75C7-41BC-9C8B-73276B58F550
    AppIdlong

    The unique ID of the application.

    		20112314518278

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-07-28The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Extend
    2023-03-23The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: Source