Querying Custom Endpoints

Description

This API is used to query the endpoint list.

Constraints

This function is only supported in CN-Hong Kong.

URI

GET /v1/{project_id}/maas/services/custom-endpoint/endpoint

**Table 1** URI parameters
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: N/A. Default Value: N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. The token can be obtained by calling the IAM API 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.

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number of all endpoints under the current account. Range: N/A.
count	String	Definition: Number of records you want to query. Range: N/A.
items	Array[CustomEndpointInfo]	Definition: Endpoint list. For details, see Table 4. Range: N/A.
quantity_limit	Integer	Definition: Maximum number of endpoints. Range: N/A.

**Table 4** CustomEndpointInfo
Parameter	Type	Description
id	String	Definition: Endpoint ID. Range: N/A.
source	String	Definition: Resource type of the endpoint. Range: custom_from_maas: Built-in service on the MaaS Real-Time Inference page, which is billed by MaaS. custom_from_modelarts_v2: ModelArts new-version real-time service, which is billed by ModelArts.
status	String	Definition: Status of the endpoint. Range: N/A.
cbc_status	String	Definition: CBC status of the endpoint. Range: N/A.
endpoint_name	String	Definition: Endpoint name entered by you. Range: N/A.
remark	String	Definition: Description of the endpoint entered by you. Range: N/A.
rpm	Integer	Definition: RPM value of the endpoint entered by you. If no value is set, the value is null. Range: N/A.
tpm	Integer	Definition: TPM value of the endpoint entered by you. If no value is set, the value is null. Range: N/A.
served_model_name	String	Definition: Name of the built-in model used when the endpoint is called. Range: N/A.
model_version_id	String	Definition: Built-in model version based on which the endpoint is created. If this parameter is left empty, the entire model is used. Range: N/A.
resident_model_id	String	Definition: ID of the built-in service model. Range: N/A.
moderation	Boolean	Definition: Whether content guard is enabled for the endpoint. Range: true: Content guard blocks harmful content in inputs and outputs during model inference. Enabling it might slow down processing. false: When disabled, the model relies on their native security features.
region	String	Definition: Region where the endpoint based on ModelArts real-time services is located. Range: N/A.
backend_model_name	String	Definition: Actual model name rewritten by the gateway when calling the backend model. Range: N/A.
created_at	String	Definition: Creation time. Range: N/A.
updated_at	String	Definition: Update time. Range: N/A.
sku_code	String	Definition: SKU code of the built-in model. Range: N/A.
base_url	String	Definition: Base URL of the built-in model. Range: N/A.
resident_model_rpm	Integer	Definition: RPM value of the built-in model. Range: N/A.
resident_model_tpm	Integer	Definition: TPM value of the built-in model. Range: N/A.
model_type_key	Array[String]	Definition: Model type. Range: N/A.
version_served_model_name	String	Definition: Version of the built-in model used when the endpoint is called. Range: N/A.
billing_mode_for_ui	Object	Definition: Billing mode. Range: N/A.
billing_factor_list	Array[Object]	Definition: Billing factor list. Range: N/A.
billing_desc	Object	Definition: Billing description. Range: N/A.
model_name	String	Definition: Model name. Range: N/A.
version_name	String	Definition: Model version name. Range: N/A.
supported_api_schemas	Array[string]	Definition: List of supported API call methods. Range: N/A.
resource_id	String	Definition: Resource ID. Range: N/A.
moderation_visible	Boolean	Definition: Specifies whether content guard can be enabled. Range: N/A.

**Table 5** Error response parameters
Parameter	Type	Description
error_msg	String	Definition: Error description. Range: N/A.
error_code	String	Definition: Error code, indicating the error type. Range: N/A.

Request Example

The following uses obtaining the endpoint list as an example.

GET
/v1/{project_id}/maas/services/custom-endpoint/endpoint

Response Example

Success response. Status code: 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 endpoint test 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",
                "en_us": "token-based billing"
            },
            "billing_factor_list": [
                {
                    "type": "input",
                    "en_us": "input",
                    "measure_id": 109,
                    "usage_factor_list": [
                        "input"
                    ]
                },
                {
                    "type": "output",
                    "en_us": "output",
                    "measure_id": 109,
                    "usage_factor_list": [
                        "output"
                    ]
                }
            ],
            "billing_desc": {
                "en_us": ""
            },
            "model_name": "DeepSeek-V3.1",
            "version_name": "20250929",
            "supported_api_schemas": [
                "v1",
                "v2",
                "anthropic"
            ],
            "resource_id": "062474c0-8124-4e6e-bbeb-01ab86******"
        }
    ]
}

Failure response. Status code: 400.

{
    "error_msg": "Invalid token.",
    "error_code": "ModelArts.0104"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic:Endpoint

Previous topic: Editing an Endpoint

Next topic: Deleting an Endpoint

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