Querying Dedicated Resources

Function

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

Constraints

This API supports GeminiDB Cassandra instances.

Authorization

Each account is authorized to call all APIs, but its IAM users must be granted necessary permissions. For details, see Permission Policies and Supported Actions.

URI

GET /v3/{project_id}/dedicated-resources

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Explanation: 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. Values: 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	Explanation: Maximum dedicated resources to be queried Constraints: N/A Values: 1–100 Default value: If this parameter is not transferred, the first 100 instances are queried by default.

Request Parameters

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

Response Parameters

Status code: 200

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

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

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

Example Request

URI example

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

Example Response

Status code: 200

Successful request

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