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

Querying Apps Bound to an API

Description

This API is used to query the list of apps that have been bound to a specified API.

URL

  • URI format

    GET /v1/{project_id}/service/authorize/apis/{api_id}[?offset,limit]

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

    api_id

    Yes

    String

    API ID

    offset

    No

    Integer

    Query start coordinate, that is, skipping the first X records. The value can only be 0 or an integer multiple of limit. If the requirement is not met, the value is rounded down. 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 100. The value range is [1, 100].

Request Message

  • Example request

    None

Response

  • Example response
    {
      "total": 1,
      "records": [
        {
          "app_id": "908489209a320df61607355c57c82882",
          "app_name": "app_demo",
          "api_using_time": 1580452617000,
          "approval_time": 1578897421000
        }
      ]
    }
  • Response parameter description

    Parameter

    Type

    Description

    total

    Integer

    Number of apps that match the query conditions

    records

    Dictionary

    Apps that are returned

    • records parameter description

      Parameter

      Type

      Description

      app_id

      String

      App ID

      app_name

      String

      App name

      api_using_time

      Long

      Expiry time of using the API, which is a 13-digit timestamp

      approval_time

      Long

      Authorization time, which is a 13-digit timestamp

Status Code

Status Code

Description

200

The message list is obtained.

For details about status codes, see Status Codes.