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

Obtaining the List of APIs in a Catalog

Description

This API is used to obtain the list of APIs in a catalog.

URL

  • URI format

    GET /v1/{project_id}/service/servicecatalogs/{catalog_id}/apis[?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.

    catalog_id

    Yes

    String

    Catalog 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 100. The value range is [1, 100].

Request Message

  • Example request

    None

Response

  • Example response
    {
      "total": 1,
      "apis": [
        {
          "id": "fd0beac79418d65e3b3ed24a6e33b24b",
          "name": "testApi",
          "catalog_id": "677942eeca42b85d82fcef909d8345f4",
          "create_time": 1579162215000,
          "status": "API_STATUS_CREATED",
          "manager": "admin",
          "type": null,
          "debug_status": "API_DEBUG_WAITING"
        }
      ]
    }
  • Response parameter description

    Parameter

    Type

    Description

    total

    Integer

    Total number of records that match the query conditions

    apis

    Dictionary

    APIs that are returned

    • apis parameters

      Parameter

      Type

      Description

      id

      String

      API Id

      name

      String

      API name

      catalog_id

      String

      Service catalog ID

      create_time

      Long

      Creation time (a 13-digit timestamp)

      status

      String

      API status. This parameter is unavailable for the Exclusive edition.

      API_STATUS_CREATED: The API has been created.

      API_STATUS_PUBLISH_WAIT_REVIEW: The API has been published and is waiting to be reviewed.

      API_STATUS_PUBLISH_REJECT: The request to publish the API has been rejected.

      API_STATUS_PUBLISHED: The API has been published.

      API_STATUS_WAITING_STOP: The API is to be suspended.

      API_STATUS_STOPPED: The API has been suspended.

      API_STATUS_RECOVER_WAIT_REVIEW: The request to recover the API waits to be reviewed.

      API_STATUS_WAITING_OFFLINE: The API is pending offline.

      API_STATUS_OFFLINE: The API is offline.

      API_STATUS_OFFLINE_WAIT_REVIEW: The API offline request is waiting to be reviewed.

      debug_status

      String

      API debugging status. This parameter is unavailable for the Exclusive edition.

      API_DEBUG_WAITING: The API is waiting to be debugged.

      API_DEBUG_FAILED: API debugging fails.

      API_DEBUG_SUCCESS: API debugging is successful.

      type

      String

      API type (not displayed). Available values include:

      API_SPECIFIC_TYPE_CONFIGURATION: configuration API

      API_SPECIFIC_TYPE_SCRIPT: script API

      API_SPECIFIC_TYPE_REGISTER: registration API

      manger

      String

      Reviewer name

Status Code

Status Code

Description

200

The list of sub-catalogs is obtained.

For details about status codes, see Status Codes.