All Products
Search

This Product

    API Gateway:CreateApp

    Document Center

    API Gateway:CreateApp

    Last Updated:Oct 19, 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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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
    Tagarray<object>No

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

    		Key， Value
    objectNo
    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 changedView Change Details
    2023-03-23The request parameters of the API has changedView Change Details