Help Center/ DataArts Fabric/ API Reference/ APIs/ Service Specifications/ Querying the Resource Specification List
Updated on 2025-09-15 GMT+08:00
View PDF
Share

Querying the Resource Specification List

Function

This API is used to list resource specifications. You can use this API to list resource specifications. You can filter resource specifications by code, type, and use case. Pagination query is supported. This API is synchronous with no accompanying APIs or specific scenarios.

URI

GET /v1/specs

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

spec_code

No

String

Specification code.

spec_types

No

Array of strings

Definition: Collection of resource specification types, allowing you to search for resource specifications by their type.

Constraints: The specifications must be queried from the specification list.

Range: [0, 100].

Default Value: N/A.

offset

No

Integer

Definition: Offset where a query starts.

Constraints: N/A.

Range: [0, 1000000000].

Default Value: 0

limit

No

Integer

Definition: Maximum number of records returned on each page.

Constraints: N/A.

Range: [1, 100].

Default Value: 10.

scenario

No

Object

Definition: Use case of specifications.

Constraints: N/A.

Range:

  • If this parameter is not specified, resource specifications can be used in any scenario.

  • COMPUTE: Physical node specification configured when you purchase Ray compute resources.

  • ENDPOINT: Resource group specification configured when you create an endpoint.

Default Value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total

Integer

Definition: Total number of specifications.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

spec_codes

Array of Spec objects

Definition: Specification code list.

Constraints: N/A.

Range: [0, 100].

Default Value: N/A.
Table 3 Spec

Parameter

Type

Description

spec_code

String

Definition: Resource specifications.

Constraints: N/A.

Range: The value must be queried from the specifications list.

Default Value: N/A.

spec_type

String

Definition: Resource specification type.

Constraints: N/A.

Range:

  • APU;

  • SQL_DPU;

  • MU;

  • RESOURCE_USAGE_UNIT;

  • RAY_APU;

  • RAY_DPU;

  • RAY_CACHE.

Default Value: N/A.

resource_type

String

Definition: Resource type.

Constraints: N/A.

Range: [1, 64].

Default Value: N/A.

stride

Integer

Definition: Resource stride.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

unit

String

Definition: Resource unit.

Constraints: N/A.

Range: [1, 16].

Default Value: N/A.

min_stride_num

Integer

Definition: Number of resource steps.

Constraints: N/A.

Range: [1, 10000]. The input value must be a value in the step count whitelist of the specification list API.

Default Value: N/A.

max_stride_num

Integer

Definition: Number of resource steps.

Constraints: N/A.

Range: [1, 10000]. The input value must be a value in the step count whitelist of the specification list API.

Default Value: N/A.

usage_measure_id

Integer

Definition: Usage unit ID.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

usage_factor

String

Definition: Usage factor.

Constraints: N/A.

Range: [1, 32].

Default Value: N/A.

stride_num_whitelist

Array of integers

Definition: Step count whitelist. The returned step count must be a value in the whitelist.

Constraints: N/A.

Range: [0, 100].

Default Value: N/A.

extra_info

SpecExtraInfo object

Definition: Additional information.

Constraints: N/A.
Table 4 SpecExtraInfo

Parameter

Type

Description

mu_multiple

Double

Definition: Conversion multiple of a model unit.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

mu_code

String

Definition: Model unit code.

Constraints: N/A.

Range: [1, 64].

Default Value: N/A.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 408

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Example Requests

GET https://{endpoint}/v1/specs

Example Responses

Status code: 200

The specification list is queried.

{
  "total" : 1,
  "spec_codes" : [ {
    "spec_code" : "string",
    "spec_type" : "APU",
    "resource_type" : "hws.resource.type.fabric.ray.dpu",
    "stride" : 1,
    "unit" : "string",
    "min_stride_num" : 0,
    "max_stride_num" : 1,
    "usage_measure_id" : 6,
    "usage_factor" : "string",
    "stride_num_whitelist" : [ 12, 13 ],
    "extra_info" : {
      "mu_multiple" : 0,
      "mu_code" : "string"
    }
  } ]
}

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

The specification list is queried.

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

Error Codes

See Error Codes.

Parent topic: Service Specifications