Querying Dedicated Resources

Function

This API is used to query dedicated resources created by a user.

Constraints

This API supports GeminiDB Cassandra instances.

Authorization Information

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

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

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
gaussdbfornosql:instance:listExclusiveResource	List	-	-	-	-

URI

GET /v3/{project_id}/dedicated-resources

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. The query starts from the next dedicated resource creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data. Constraints The value must be greater than or equal to 0. Range N/A Default Value If this parameter is not transferred, offset is set to 0 by default, which indicates that the query starts from the latest created dedicated resource.
limit	No	Integer	Definition Maximum dedicated resources to be queried Constraints N/A Range 1–100 Default Value If this parameter is not transferred, the first 100 instances are queried by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	Definition User token To obtain this value, call the IAM API for obtaining a user token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records Range N/A
resources	Array of DedicatedResource objects	Definition Dedicated resource information Range N/A

**Table 5** DedicatedResource
Parameter	Type	Description
id	String	Definition Dedicated resource ID Range N/A
resource_name	String	Definition Dedicated resource name Range N/A
engine_name	String	Definition API name Range N/A
availability_zone	String	Definition AZ information Range N/A
architecture	String	Definition Type of the compute host in the dedicated resource Range X86: x86 ARM: Kunpeng
capacity	DedicatedResourceCapacity object	Definition Capacity of a dedicated resource Range N/A
status	String	Definition Status of a dedicated resource Range NORMAL: A dedicated resource is available. BUILDING: A dedicated resource is being built.

**Table 6** DedicatedResourceCapacity
Parameter	Type	Description
vcpus	Integer	Definition CPU cores Range N/A
ram	Integer	Definition Memory size (GB) Range N/A
volume	Integer	Definition Storage size (GB) Range N/A

Example Requests

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/dedicated-resources?offset=0&limit=10

Example Responses

Status code: 200

Successful response

{
  "total_count" : 2,
  "resources" : [ {
    "id" : "300acc71-eca9-4c6b-9a4e-0d25e20fe54c",
    "resource_name" : "nosql-dedicated-resource-1",
    "engine_name" : "cassandra",
    "availability_zone" : "az1,az2,az3",
    "architecture" : "X86",
    "capacity" : {
      "vcpus" : 192,
      "ram" : 1536,
      "volume" : 300000
    },
    "status" : "NORMAL"
  }, {
    "id" : "4c423cd8-551f-4b74-934f-8534e4a9bf2b",
    "resource_name" : "nosql-dedicated-resource-2",
    "engine_name" : "cassandra",
    "availability_zone" : "az1,az2,az3",
    "architecture" : "X86",
    "capacity" : {
      "vcpus" : 192,
      "ram" : 1536,
      "volume" : 300000
    },
    "status" : "BUILDING"
  } ]
}