获取服务列表
功能介绍
获取服务列表接口用于获取服务ID对应的服务名称。
接口约束
- 区域限制：仅支持西南-贵阳一区域。
- API流量限制：所有用户对该API的总请求次数上限，1分钟内不超过1000次。
- 用户流量限制：单个用户对该API的请求次数上限，1分钟内不超过200次。
- 限流响应：超出限流阈值时，API将返回HTTP 429状态码（Too Many Requests）。
- 重试建议：遇到限流时，建议等待60秒后重试。
URI
POST /v1/{project_id}/maas/monitoring/list-services
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：项目ID。关于如何获取项目ID，请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：只能由小写英文字母和数字组成，长度32字符。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释：用户Token。通过调用IAM服务的获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取方式请参见认证鉴权。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
service_type |
是 |
Integer |
参数解释：服务类型。 约束限制：不涉及。 取值范围：枚举类型，取值如下：
默认取值：不涉及。 |
|
service_ids |
否 |
Array of strings |
参数解释：待查询的服务ID列表服务，根据传入的服务ID列表筛选；不传则所有服务ID对应的服务名称。服务ID在创建服务时即可在返回体中获取，也可通过获取服务列表接口获取当前用户拥有的服务，其中service_id字段即为服务ID。 约束限制：不涉及。 取值范围：每个服务ID长度 1-128 字符，仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 默认取值：不涉及。 |
|
limit |
否 |
Integer |
参数解释：分页条数，表示本次最多返回多少条数据。 约束限制：不涉及。 取值范围：分页条数需要大于0且小于100。 默认取值：10。 |
|
offset |
否 |
Integer |
参数解释：分页偏移量，表示跳过多少条数据查询后面的数据。 约束限制：不涉及。 取值范围：大于等于0。 默认取值：0。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释：查询到的服务总数。 取值范围：不涉及。 |
|
count |
Integer |
参数解释：当前分页返回的数据条数。 取值范围：不涉及。 |
|
items |
Array of ListServiceItem objects |
参数解释：服务列表。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
service_id |
String |
参数解释：服务ID。 取值范围：不涉及。 |
|
service_name |
String |
参数解释：服务名称。 取值范围：不涉及。 |
状态码：400
请求示例
查询服务ID为 "08d1b2ad-da2e-4a69-b71a-eedb9b120121"且服务类型为预置服务的服务名称。
/v1/{project_id}/maas/monitoring/list-services
{
"service_ids" : [ "08d1b2ad-da2e-4a69-b71a-eedb9b120121" ],
"service_type" : 2
}
响应示例
状态码：200
成功响应。
{
"total" : 1,
"count" : 1,
"items" : [ {
"service_id" : "4f6d50ec-0e80-4ea0-983b-d0ad1ede7596",
"service_name" : "deepseek.v3.1"
} ]
}
状态码：400
失败响应。
{
"error_code" : "common.00000400",
"error_msg" : "field 'limit' 需要在0和100之间"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应。 |
|
400 |
失败响应。 |
错误码
请参见错误码。
