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

Querying the App List

Description

This API is used to query the app list.

URL

  • URI format

    GET /v1/{project_id}/service/apps [?offset,limit,name,app_type]

  • 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.

    offset

    No

    Integer

    Query start coordinate, that is, skipping the first X records. The default value is 0. The value range is [0, MAX_INTEGER).

    limit

    No

    Integer

    Number of records to be queried, that is, Y records. The default value is 10. The value range is [1, 100].

    name

    No

    String

    App name. Fuzzy search is supported.

    app_type

    No

    String

    App type

    IAM: IAM authentication

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

Request Message

  • Example request

    None

Response

  • Example response
    {
      "total": 1,
      "apps": [
        {
          "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

    total

    Integer

    Total number of apps that match the query conditions

    apps

    Dictionary

    Total number of apps that match the query conditions

    • apps parameters

      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.