Updated on 2024-03-15 GMT+08:00

Querying Resource Type

Function

This API is used to query the resource types and applicable regions of interconnected cloud services.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v1/resource-types

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of entries that can be displayed on a page.

Minimum: 1

Maximum: 2000

Default: 50

marker

No

String

Page marker.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

resource_types

Array of ResourceTypesSummary objects

List of details about cloud service resources

Array Length: 0 - 2000

page_info

PageInfo object

Pagination details.

Table 4 ResourceTypesSummary

Parameter

Type

Description

region_id

String

Name of the region to which the resources belong

Minimum: 1

Maximum: 255

resource_type

String

Name of the resource type

Minimum: 1

Maximum: 64

Table 5 PageInfo

Parameter

Type

Description

previous_marker

String

Marker of the previous page.

Minimum: 1

Maximum: 64

next_marker

String

Marker of the next page.

Minimum: 1

Maximum: 64

current_count

Integer

Page size.

Minimum: 1

Maximum: 2000

Example Requests

Getting the resource types and applicable regions of interconnected cloud services

GET https://{hostname}/v1/resource-types

Example Responses

Status code: 200

Request succeeded.

{
  "resource_types" : [ {
    "region_id" : "string",
    "resource_type" : "string"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.