查询自定义接入点
功能介绍
该API用于查询用户接入点列表。
接口约束
该功能仅支持“西南-贵阳一”区域。
URI
GET /v1/{project_id}/maas/services/custom-endpoint/endpoint
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project-id |
是 |
String |
参数解释:项目ID。关于如何获取项目ID,请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务的获取用户Token接口获取(响应消息头中X-Subject-Token的值)。具体操作,请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释:当前账号下所有自定义接入点总数。 取值范围:不涉及。 |
|
count |
String |
参数解释:本次查询数量。 取值范围:不涉及。 |
|
items |
Array[CustomEndpointInfo] |
参数解释:自定义接入点列表,详情请参见表4。 取值范围:不涉及。 |
|
quantity_limit |
Integer |
参数解释:最大自定义接入点数量限制。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释:自定义接入点的ID。 取值范围:不涉及。 |
|
source |
String |
参数解释:自定义接入点的资源类型。 取值范围:
|
|
status |
String |
参数解释:自定义接入点的状态。 取值范围:不涉及。 |
|
cbc_status |
String |
参数解释:自定义接入点的CBC状态。 取值范围:不涉及。 |
|
endpoint_name |
String |
参数解释:用户填写的自定义接入点的名称。 取值范围:不涉及。 |
|
remark |
String |
参数解释:用户填写的自定义接入点的描述。 取值范围:不涉及。 |
|
rpm |
Integer |
参数解释:用户设置自定义接入点流控时的RPM值,未设置时为null。 取值范围:不涉及。 |
|
tpm |
Integer |
参数解释:用户设置自定义接入点流控时的TPM值,未设置时为null。 取值范围:不涉及。 |
|
served_model_name |
String |
参数解释:调用自定义接入点时使用的预置模型名称。 取值范围:不涉及。 |
|
model_version_id |
String |
参数解释:记录基于哪个预置模型版本创建出来的自定义接入点,为空则指代整个模型。 取值范围:不涉及。 |
|
resident_model_id |
String |
参数解释:预置服务模型ID。 取值范围:不涉及。 |
|
moderation |
Boolean |
参数解释:自定义接入点内容安全护栏开关。 取值范围:
|
|
region |
String |
参数解释:基于AI开发平台ModelArts-在线服务的自定义接入点所处的区域。 取值范围:不涉及。 |
|
backend_model_name |
String |
参数解释:调用后端模型时网关改写后的真实模型名称。 取值范围:不涉及。 |
|
created_at |
String |
参数解释:创建时间。 取值范围:不涉及。 |
|
updated_at |
String |
参数解释:更新时间。 取值范围:不涉及。 |
|
sku_code |
String |
参数解释:预置模型的SKU码。 取值范围:不涉及。 |
|
base_url |
String |
参数解释:预置模型的BaseUrl。 取值范围:不涉及。 |
|
resident_model_rpm |
Integer |
参数解释:预置模型的RPM值。 取值范围:不涉及。 |
|
resident_model_tpm |
Integer |
参数解释:预置模型的TPM值。 取值范围:不涉及。 |
|
model_type_key |
Array[String] |
参数解释:模型类型。 取值范围:不涉及。 |
|
version_served_model_name |
String |
参数解释:调用自定义接入点时使用的预置模型版本。 取值范围:不涉及。 |
|
billing_mode_for_ui |
Object |
参数解释:计费模式。 取值范围:不涉及。 |
|
billing_factor_list |
Array[Object] |
参数解释:计价因子列表。 取值范围:不涉及。 |
|
billing_desc |
Object |
参数解释:计价描述。 取值范围:不涉及。 |
|
model_name |
String |
参数解释:模型名称。 取值范围:不涉及。 |
|
version_name |
String |
参数解释:模型版本名称。 取值范围:不涉及。 |
|
supported_api_schemas |
Array[string] |
参数解释:支持的调用API方式列表。 取值范围:不涉及。 |
|
resource_id |
String |
参数解释:资源ID。 取值范围:不涉及。 |
|
moderation_visible |
Boolean |
参数解释:是否可以开关安全护栏。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释:错误描述信息。 取值范围:不涉及。 |
|
error_code |
String |
参数解释:错误码,标识错误类型。 取值范围:不涉及。 |
请求示例
此处以查询接入点列表为例。
GET
/v1/{project_id}/maas/services/custom-endpoint/endpoint
响应示例
- 成功响应,状态码:200。
{ "total": 1, "count": 1, "quantity_limit": 10, "items": [ { "id": "c4513589-df2e-4d58-ab0c-d5a6f2******", "endpoint_name": "DeepSeek-Test", "served_model_name": "deepseek-v3.1-4ZGlnU", "rpm": null, "tpm": null, "cbc_status": "byToken", "status": "normal", "source": "custom_from_maas", "resident_model_id": "1671ce67-033a-4d9e-9fb9-fd81a4******", "model_version_id": "8d41f3ad-f75b-4a8f-bd31-5a8f9d******", "remark": "DeepSeek自定义接入点测试1", "moderation": true, "region": "", "backend_model_name": "deepseek-v3.1", "created_at": "2025-12-09T11:32:46+08:00", "updated_at": "2025-12-09T11:36:21+08:00", "base_url": "https://api.modelarts-maas.com", "sku_code": "modelarts.tokens.deepseek.v3.1", "resident_model_rpm": 1500, "resident_model_tpm": 500000, "model_type_key": [ "Text Generation" ], "version_served_model_name": "deepseek-v3.1", "billing_mode_for_ui": { "type": "tokens", "zh_cn": "按token计费", "en_us": "token-based billing" }, "billing_factor_list": [ { "type": "input", "zh_cn": "输入", "en_us": "input", "measure_id": 109, "usage_factor_list": [ "input" ] }, { "type": "output", "zh_cn": "输出", "en_us": "output", "measure_id": 109, "usage_factor_list": [ "output" ] } ], "billing_desc": { "zh_cn": "", "en_us": "" }, "model_name": "DeepSeek-V3.1", "version_name": "20250929", "supported_api_schemas": [ "v1", "v2", "anthropic" ], "resource_id": "062474c0-8124-4e6e-bbeb-01ab86******" } ] } - 失败响应,状态码:400。
{ "error_msg": "Invalid token.", "error_code": "ModelArts.0104" }
状态码
请参见状态码。
错误码
请参见错误码。