Help Center/ ServiceStage/ API Reference (ME-Abu Dhabi Region)/ CSE API/ Querying All Schema Information About a Microservice
Updated on 2023-06-25 GMT+08:00

Querying All Schema Information About a Microservice

Function

This API is used to query all schema information (including schemaId and summary) about a microservice.

URI

GET /v4/{project_id}/registry/microservices/{serviceId}/schemas

Table 1 Path parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Fixed value: default.

serviceId

String

Yes

Microservice ID, which must be unique.

The value must be 1 to 64 characters long.

Regular expression: ^.*$

Table 2 Query parameters

Parameter

Type

Mandatory

Description

withSchema

String

No

Whether to query the schema content. Default value: 0. Options:
  • 0: Only schemaId and summary are displayed.
  • 1: schemaId, summary, and schema are displayed.

Request

Request parameters

None

Response

Response parameters

Table 3 describes the parameters.

Table 3 Parameter

Parameter

Type

Description

schemas

Array of objects

Struct list of all microservice schemas. For details, see Schema.

Example

Example request

None

Example response

{
    "schemas": [
        {
            "schemaId": "xxxx",
            "schema": "xxxx", // A value is returned only when the value of withSchema in the URL is 1. By default, no value is returned.
            "summary": "abcd"
        }
    ]
}

Status Code

See Status Codes.

Error Code

See CSE Error Codes.