All Products
Search

This Product

    Simple Log Service:CreateApiKey

    Document Center

    Simple Log Service:CreateApiKey

    Last Updated:Nov 03, 2026

    Creates an API key resource in a specified project.

    Operation description

    Request description

    • You can create up to 10 API keys in each project.

    • The apiKeyName must be unique within the project and cannot be modified after creation.

    • The allowedStores field cannot be empty and supports wildcard matching.

    • The system automatically generates the plaintext of the API key upon creation. You cannot customize it.

    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

    log:CreateApiKey

    create

    *All Resource

    *

    		 None None

    Request syntax

    POST /apikeys HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    Yes

    The request data.

    apiKeyName

    string

    No

    The name of the API key.

    demo-apikey-001
    description

    string

    No

    The description.

    test
    allowedStores

    array

    No

    The list of Logstores to which data can be written.

    string

    No

    The name of the Logstore.

    test
    project

    string

    No

    The name of the project.

    test

    Response elements

    Element

    Type

    Description

    Example

    None defined.

    Examples

    Success response

    JSON format

    {}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.