Obtaining the Service List

Function

This API is used to obtain the service name based on the service ID.

Constraints

Region restrictions: Only the CN-Hong Kong region is supported.
API rate limiting: The total number of requests for this API from all users cannot exceed 1,000 within one minute.
User request limit: The number of requests for this API from a single user cannot exceed 200 within one minute.
Rate-limiting response: When the rate limit is exceeded, the API returns the HTTP status code 429 "Too Many Requests".
Retry suggestion: If the rate limit is exceeded, wait 60 seconds and try again.

URI

POST /v1/{project_id}/maas/monitoring/list-services

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID, see Obtaining a Project ID and Name. Constraints: N/A Range: The value can contain 32 characters. Only lowercase letters and digits are allowed. Default Value: N/A

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details, see Authentication. Constraints: N/A Range: N/A Default Value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
service_type	Yes	Integer	Definition: Service type. Constraints: N/A Range: 1: User services. Deploy the model service in the My Services tab. For details, see Deploying a Model Service. 2: Built-in services. Deploy the model service in the Built-in Services tab. For details, see Subscribing to a Built-in Service. Default Value: N/A
service_ids	No	Array of strings	Definition: Service IDs to be queried. Services are filtered based on the input service ID list. If this parameter is not specified, all service names corresponding to the IDs are returned. You can obtain the service ID from the response body during service creation, or call the API for obtaining the service list. The service_id field indicates the service ID. Constraints: N/A Range: The value can contain 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Default Value: N/A
limit	No	Integer	Definition: Number of records on each page, that is, maximum number of returned records. Constraints: N/A Range: 0 to 100 Default Value: 10.
offset	No	Integer	Definition: Pagination offset, which indicates the number of records to be skipped. Constraints: N/A Range: The value must be greater than or equal to 0. Default Value: 0

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of queried services. Range: N/A
count	Integer	Definition: Number of data records returned on the current page. Range: N/A
items	Array of ListServiceItem objects	Definition: Service list. Range: N/A

**Table 5** ListServiceItem
Parameter	Type	Description
service_id	String	Definition: Service ID. Range: N/A
service_name	String	Definition: Service name. Range: N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code, which identifies the error type. For details, see MaaS Error Codes. Range: N/A
error_msg	String	Definition: Error description. For details, see MaaS Error Codes. Range: N/A

Request Example

Query the name of the preset service whose ID is 08d1b2ad-da2e-4a69-b71a-eedb9b120121.

/v1/{project_id}/maas/monitoring/list-services

{
  "service_ids" : [ "08d1b2ad-da2e-4a69-b71a-eedb9b120121" ],
  "service_type" : 2
}

Response Example

Status code: 200

Success response

{
  "total" : 1,
  "count" : 1,
  "items" : [ {
    "service_id" : "4f6d50ec-0e80-4ea0-983b-d0ad1ede7596",
    "service_name" : "deepseek.v3.1"
  } ]
}

Status code: 400

Failure response

{
  "error_code" : "common.00000400",
  "error_msg" : "The value of field limit must range from 0 to 100."
}

Status Codes

Status Code	Description
200	Success response
400	Failure response

Error Codes

For details, see Error Codes.

Parent Topic: MaaS Call Statistics

Previous topic: Obtaining Service Error Details

Next topic: Querying the IP Address List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

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

Chatbot