Help Center/ Config/ API Reference/ APIs/ Advanced Queries/ Querying Schemas
Updated on 2025-12-15 GMT+08:00
View PDF

Querying Schemas

Function

This API is used to query schemas used by advanced queries.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/schemas

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies the account ID.

Maximum: 36
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the maximum number of records to return.

Minimum: 1

Maximum: 200

Default: 200

marker

No

String

Specifies the pagination parameter. You can use the marker value in a subsequent call to request the next set of list items.

Minimum: 4

Maximum: 400

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Specifies the invoker's token.

X-Security-Token

No

String

Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

value

Array of ResourceSchemaResponse objects

schemas object.

page_info

PageInfo object

Specifies the pagination object.
Table 5 ResourceSchemaResponse

Parameter

Type

Description

type

String

Specifies the resource type.

schema

Object

Specifies the schema content.
Table 6 PageInfo

Parameter

Type

Description

current_count

Integer

Specifies the resource quantity on the current page.

Minimum: 0

Maximum: 200

next_marker

String

Specifies the marker value of the next page.

Minimum: 4

Maximum: 400

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

None

Example Responses

Status code: 200

Operation succeeded.

{
  "value" : [ {
    "type" : "aad.intances",
    "schema" : {
      "expireTime" : "int",
      "ispSpec" : "string",
      "specType" : "int",
      "basicBandwidth" : "int",
      "elasticBandwidth" : "int",
      "serviceBandwidth" : "int"
    }
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}

Status Codes

Status Code

Description

200

Operation succeeded.

400

Invalid parameters.

403

User authentication failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: Advanced Queries