Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Specification Management/ Querying the Specification List
Updated on 2024-02-21 GMT+08:00
View PDF
Share

Querying the Specification List

Function

This API is used to query the specification list.

URI

GET /v1/{project_id}/specs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID (lakeformation_04_0026.xml).
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

spec_code

No

String

Specification code. The system automatically generates a value, for example, lakeformation.unit.basic.qps.

offset

No

Integer

Offset. The value ranges from 0 to 100. The default value is 0.

limit

No

Integer

Number of records to be queried at a time. The value ranges from 1 to 100. The default value is 10.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number.

spec_codes

Array of Spec objects

Resource specification code list.
Table 4 Spec

Parameter

Type

Description

spec_code

String

Specification code. For example, lakeformation.unit.basic.qps: indicates the query rate per second (QPS) specification.

resource_type

String

Resource code.

stride

Integer

Step.

unit

String

Unit.

min_stride_num

Integer

Minimum number of steps.

max_stride_num

Integer

Maximum number of steps.

usage_measure_id

Integer

Usage measurement ID.

usage_factor

String

Usage factor.

usage_value

Integer

Total usage. Suppose you set a limit of 1 million API calls and 1 million metadata records as free, and charge CNY5 for each extra million API calls and each extra 100,000 metadata records. If this parameter shows 2 million API calls and 1.1 million metadata records, you have to pay for 1 million API calls and 100,000 metadata records.

free_usage_value

Integer

Free quota for API calls and metadata storage, which is set by users. This parameter will return a result shows that how many API calls are free of charge and how many metadata can be stored for free. Suppose you set a limit of 1 million API calls and 1 million metadata records as free, this parameter shows 1 million API calls and 1 million metadata records.

stride_num_whitelist

Array of integers

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

Status code: 204

Table 5 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, which is used to locate auxiliary information.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Example Requests

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

Example Responses

Status code: 200

Specification list.

{
  "total" : 1,
  "spec_codes" : [ {
    "spec_code" : "hws.resource.type.lakeformation.qps",
    "resource_type" : "hws.resource.type.lakeformation.metadata",
    "stride" : 2000,
    "unit" : "qps",
    "min_stride_num" : 1,
    "max_stride_num" : 100,
    "usage_measure_id" : 6,
    "usage_factor" : "Duration",
    "usage_value" : 1,
    "free_usage_value" : 1,
    "stride_num_whitelist" : [ 1, 2 ]
  } ]
}

Status code: 400

Bad Request

{
  "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",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

Not Found

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

Status code: 408

Request Timeout

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

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

200

Specification list.

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Specification Management