Help Center> DataArts Studio> API Reference> Data Lake Mall APIs> Service Catalog Management> Obtaining the List of Sub-Catalogs in a Catalog
Updated on 2022-09-15 GMT+08:00

Obtaining the List of Sub-Catalogs in a Catalog

Description

This API is used to obtain the list of sub-catalogs in a catalog. (The returned sub-catalogs are displayed on the same page. It is recommended that this API be used only in scenarios where pagination is not supported, for example, generating a catalog tree.)

URL

  • URI format

    GET /v1/{project_id}/service/servicecatalogs/{catalog_id}/catalogs

  • 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

Request Message

  • Example request

    None

Response

  • Example response
    {
      "total": 1,
      "api_catalogs": [
        {
          "catalog_id": "2847131b4d5a26c5bd4bfd9d8f63f577",
          "pid": "8c9850726a1ee050be2b67e43c688870",
          "name": "demo",
          "description": "this is a demo",
          "api_catalog_type": "CATALOG",
          "create_time": 1578284788000,
          "create_user": "Tim",
          "update_time": 1578284788000,
          "update_user": "Tim"
        }
      ]
    }
  • Response parameter description

    Parameter

    Type

    Description

    total

    Integer

    Total number of records that match the query conditions

    api_catalogs

    Dictionary

    Catalogs that are returned

    • api_catalogs parameter description

      Parameter

      Type

      Description

      catalog_id

      String

      Catalog ID

      pid

      String

      Parent catalog ID

      name

      String

      Catalog name

      description

      String

      Description

      api_catalog_type

      String

      Type. Available values include:

      CATALOG

      create_time

      Long

      Time when the catalog was created, which is a 13-digit timestamp

      create_user

      String

      Name of the creator

      update_time

      Long

      Time when the catalog was updated, which is a 13-digit timestamp

      update_user

      String

      User who updated the catalog

Status Code

Status Code

Description

200

The list of sub-catalogs is obtained.

For details about status codes, see Status Codes.