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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ram:resourceTypes:list	List	-	-	-	-

URI

GET /v1/resource-types

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page. If the limit parameter is not specified, the default value is 2,000.
marker	No	String	Page marker.

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
page_info	PageInfo object	Pagination details.

**Table 4** ResourceTypesSummary
Parameter	Type	Description
region_id	String	Name of the region to which the resources belong
resource_type	String	Name of the resource type

**Table 5** PageInfo
Parameter	Type	Description
previous_marker	String	Marker of the previous page.
next_marker	String	Marker of the next page.
current_count	Integer	Number of pages.

Example Requests

Getting the resource types and applicable regions of interconnected cloud services

GET /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
  }
}