Querying the Unique Service or Schema ID of a Microservice

This API is used to query the unique service or schema ID of a microservice based on filter criteria.

GET /v4/{project_id}/registry/existence

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Fixed value: default.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Request type. microservice schema NOTE: If type is set to microservice, env, appId, serviceName, and version are mandatory. If type is set to schema, serviceId and schemaId are mandatory.
env	No	String	Microservice environment. Value: development, testing, acceptance, or production.
appId	Yes	String	Application ID, which needs to be transferred when the resource type is microservice. The value contains 1 to 160 characters. Regular expression: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$
serviceName	Yes	String	Microservice name, which needs to be transferred when the resource type is microservice. The value contains 1 to 128 characters. Regular expression: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$
version	Yes	String	Microservice version, which needs to be transferred when the resource type is microservice. The value contains 1 to 64 characters. Regular expression: ^[0-9]$\|^[0-9]+(.[0-9]+)$
serviceId	Yes	String	Microservice ID, which needs to be transferred when the resource type is schema. The value contains 1 to 64 characters. Regular expression: ^.*$
schemaId	Yes	String	Schema ID, which needs to be transferred when the resource type is schema. The value contains 1 to 160 characters. Regular expression: ^[a-zA-Z0-9]{1,160}$\|^[a-zA-Z0-9][a-zA-Z0-9_-.]{0,158}[a-zA-Z0-9]$.

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
Authorization	No	String	This parameter is mandatory if security authentication is enabled for an exclusive ServiceComb engine. Otherwise, this parameter is not required. The token of an exclusive ServiceComb engine with security authentication enabled is in the following format: Authorization:Bearer {Token} For details about how to obtain the token, see Obtaining the User Token of an Exclusive ServiceComb Engine.

Status code: 200

**Table 4** Response header parameter
Parameter	Type	Description
X-Schema-Summary	String	Summary of a microservice schema.

**Table 5** Response body parameters
Parameter	Type	Description
serviceId	String	When a service is queried, a service ID is returned.
schemaId	String	When a schema is queried, a schema ID is returned.

Status code: 400

Status code: 500

Query serviceId based on microservice as type, default as appId, service as serviceName, and 1.0.0 as version.

GET https://{endpoint}/v4/{project_id}/registry/existence?type=microservice&appId=default&serviceName=service&version=1.0.0

Status code: 200

Successfully queried. serviceId or schemaId is returned.

{
  "serviceId" : "8aed80ea052ac04a64dfc79c24f2170224d074f5"
}

Parent topic: Microservice

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.