Querying Dedicated Resources

Function

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

Constraints

This API supports GeminiDB Cassandra instances.

URI

GET https://{Endpoint}/v3/{project_id}/dedicated-resources

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index position. The query starts from the dedicated resource created after the dedicated resource indexed by this parameter in a specified project. If offset is set to N, the resource query starts from the N+1 piece of data. The value must be no less than 0. If this parameter is not transferred, offset is set to 0 by default, indicating that the query starts from the latest created dedicated resource.
limit	No	Integer	Maximum of dedicated resources to be queried. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 instances are queried by default.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of records
resources	Array of DedicatedResource objects	Dedicated resource information

**Table 4** DedicatedResource
Parameter	Type	Description
id	String	Dedicated resource ID
resource_name	String	Dedicated resource name
engine_name	String	API name.
availability_zone	String	AZ information
architecture	String	Type of dedicated compute hosts. The value can be X86 or ARM.
capacity	DedicatedResourceCapacity object	Capacity of the dedicated resource
status	String	Status of the dedicated resource. The value can be: NORMAL: indicating that the dedicated resource is available. BUILDING, indicating that the dedicated resource is being built.

**Table 5** DedicatedResourceCapacity
Parameter	Type	Description
vcpus	Integer	Number of vCPUs
ram	Integer	Memory size in GB
volume	Integer	Storage size in GB

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

Success

{
  "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"
  } ]
}