Updated on 2022-09-15 GMT+08:00

Creating an App

Description

This API is used to create an app that uses the app or IAM verification.

URL

  • URI format

    POST /v1/{project_id}/service/apps

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Message

  • Example request
    {
      "app_type": "APP",
      "name": "app_test_001",
      "description": "This is the app's description.",
    }
  • Request parameter description

    Parameter

    Mandatory

    Type

    Description

    app_type

    Yes

    String

    App type

    IAM: IAM authentication

    APP (formerly APIG/APIGW/DLM/ROMA_APIC): app authentication

    name

    Yes

    String

    App name

    description

    No

    String

    App description

Response

  • Example response
    {
      "id": "908489209a320df61607355c57c82882",
      "name": "app_test_001",
      "description": "This is the app's description.",
      "app_key": "fbbf9462bb434cb4a13ee7d2bb70c418",
      "app_secret": "c1245f01937442e098ffa6ff134cb3dc",
      "register_time": 1578284788000,
      "update_time": 1578284788000,
      "create_user": "create_user",
      "update_user": "update_user",
      "app_type": "APP"
    }
  • Response parameter description

    Parameter

    Type

    Description

    id

    String

    App ID

    name

    String

    App name

    description

    String

    App description

    app_key

    String

    App key

    app_secret

    String

    App secret

    register_time

    Long

    Registration time, which is a 13-digit timestamp

    update_time

    Long

    Update time, which is a 13-digit timestamp

    create_user

    String

    Creator

    update_user

    String

    User who updated the app

    app_type

    String

    App type

    IAM: IAM authentication

    APP: app authentication

    APIG: API Gateway Shared edition (inventory data)

    APIGW: API Gateway Dedicated edition (inventory data)

    DLM: no gateway (inventory data)

    ROMA_APIC: ROMA-APIC gateway (inventory data)

Status Code

Status Code

Description

200

success

For details about status codes, see Status Codes.