Create a key

Last updated: 2020-06-09 15:02:15

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new API Gateway API 3.0 which is standardized and faster.

    API Description

    This API (CreateApiKey) is used to create an API key pair.

    Input Parameters

    The list below contains only the API request parameters. Other parameters can be found in Common Request Parameters.

    Parameter Name Required Type Description
    secretName No String User-defined secret key name.
    secretID No String User-defined secretID, which is required when type is manual. It can contain 5 to 50 letters, digits, and underscores.
    secretKey No String User-defined secretKey, which is required when type is manual. It can contain 10 to 50 letters, digits, and underscores.
    type No String Key type. Value range: auto, manual (custom key). Default value: auto.

    The manual type is in beta. If you want to use it, please contact your sales rep or submit a ticket to be added to the whitelist.

    Output Parameters

    Parameter Name Type Description
    code Int Common error code. 0: success; other values: failure. For more information, see Common Error Codes.
    codeDesc String Description of the action status. When the action has succeeded, "Success" is returned. When the action has failed, a message describing the cause of the error is returned.
    message String API-related module error message description.
    secretName String User-defined secret key name.
    secretID String The created API secretID.
    secretKey String The created API secretKey.
    type String Key type, either auto or manual.
    createdTime Timestamp Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO8601 standard. UTC time is used.

    Samples

    Sample 1

    https://apigateway.api.qcloud.com/v2/index.php?
    &<Common Request Parameter>
    &Action=CreateApiKey
    &secretName=myTest

    Below is a sample return:

    {
        "code": "0",
        "message": "",
        "codeDesc": "Success",
        "secretName": "myTest",
        "secretID": "AKIDXXXXWKipDlK",
        "secretKey": "adasfdasffa",
        "type": "auto",
        "createdTime": "2017-08-07T00:00:00Z"
    }

    Sample 2

    https://apigateway.api.qcloud.com/v2/index.php?
    &<Common Request Parameter>
    &Action=CreateApiKey
    &secretName=myTest
    &secretID=myTestsecretID
    &secretKey=myTestSecretKey
    &type=manual

    Below is a sample return:

    {
        "code": "0",
        "message": "",
        "codeDesc": "Success",
        "secretName": "myTest",
        "secretID": "myTestsecretID",
        "secretKey": "myTestSecretKey",
        "type": "manual",
        "createdTime": "2017-08-07T00:00:00Z"
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help