Querying Supported Service Deployment Specifications

Function

This API is used to query supported service deployment specifications.

URI

GET /v1/{project_id}/services/specifications

Table 1 Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

is_personal_cluster

No

Boolean

Whether to query the service deployment specifications supported by dedicated resource pool. The default value is false.

infer_type

No

String

Inference mode. The default value is real-time. The value can be real-time or batch.

Request Body

None

Response Body

Table 2 Parameters

Parameter

Type

Description

specifications

specification array

Supported service deployment specifications. For details, see Table 3.

Table 3 specification parameters

Parameter

Type

Description

specification

String

Unique specifications ID

billing_spec

String

Unique ID of the billing specifications

spec_status

String

Specifications status

  • normal: The specifications are normal.

  • sellout: The specifications cannot be used to deploy services because they are sold out.

is_open

Boolean

Whether to enable the specifications. The default value is true. If this parameter is set to false, you need to submit a service ticket to apply for the specifications.

source_type

String

Type of the model to which the specifications apply.

  • Empty: indicates a model generated by the user.

is_free

Boolean

Whether the flavor is free of charge. The value true indicates that the flavor is free of charge.

over_quota

Boolean

Whether the quota exceeds the upper limit. The value true indicates that the quota exceeds the upper limit.

extend_params

Integer

Billing item

display_en

String

Specifications description in English

Samples

  • Sample request

    GET    https://endpoint/v1/{project_id}/services/specifications
    
  • Sample response

    {
        "specifications": [
            {
                "specification":  "modelarts.vm.gpu.v100",
                "billing_spec":  "modelarts.vm.gpu.v100",
                "is_open": true,
                "spec_status": "normal",
                "is_free": false,
                "over_quota": false,
                "extend_params": 1
            },
        ]
    }
    

Status Code

For details about the status code, see Table 1.

Error Codes

See Error Codes.