Updated on 2024-04-18 GMT+08:00

Querying Node Types

Function

This API is used to query the node types supported by GaussDB(DWS).

Call Method

For details, see Calling APIs.

URI

1
GET /v2/{project_id}/node-types
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

node_types

Array of NodeTypes objects

List of node type objects

count

Integer

Total number of node types.

Table 3 NodeTypes

Parameter

Type

Description

spec_name

String

Name of a node type

detail

Array of Detail objects

Node type details

id

String

Node type ID

datastore_type

String

Product type

  • dws: standard data warehouse.

  • hybrid: hybrid data warehouse.

  • stream: stream data warehouse.

available_zones

Array of NodeTypeAvailableZones objects

Supported AZs and their statuses

ram

Integer

Memory size

vcpus

Integer

Number of CPUs

datastores

Array of NodeTypeDatastores objects

Kernel version information

volume

VolumeResp object

For a fixed storage flavor, the value is the storage of its typical configuration. For an elastic storage flavor, the value null.

elastic_volume_specs

Array of NodeTypeElasticVolumeSpecs objects

If the specification is elastic, this attribute indicates the typical specification, including the storage type, minimum capacity, maximum capacity, and step. If the specification is fixed, this attribute is null.

Table 4 Detail

Parameter

Type

Description

type

String

Attribute type

value

String

Attribute value

unit

String

Attribute unit

Table 5 NodeTypeAvailableZones

Parameter

Type

Description

code

String

AZ ID

status

String

Availability status of a node type.

  • normal: The node type is available.

  • sellout: The VM has been sold out.

  • abandon: The node type is unavailable.

Table 6 NodeTypeDatastores

Parameter

Type

Description

version

String

OS kernel version

attachments

Attachments object

Additional information about the kernel version

Table 7 attachments

Parameter

Type

Description

min_cn

String

Minimum CNs allowed by the kernel version

max_cn

String

Maximum CNs allowed by the kernel version

Table 8 VolumeResp

Parameter

Type

Description

type

String

Disk type. Only SSD is supported.

size

Integer

Available disk capacity (GB)

Table 9 NodeTypeElasticVolumeSpecs

Parameter

Type

Description

type

String

Cloud disk type.

step

String

Cloud disk size increment

min_size

Integer

Minimum cloud disk size

max_size

Integer

Maximum cloud disk size

Example Request

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/node-types

Example Response

Status code: 200

The node type is queried successfully.

{
  "node_types" : [ {
    "spec_name" : "dws.d2.xlarge",
    "id" : "ebe532d6-665f-40e6-a4d4-3c51545b6a67",
    "datastore_type" : "dws",
    "available_zones" : [ {
      "code" : "az1",
      "status" : "normal"
    } ],
    "ram" : 32,
    "vcpus" : 4,
    "datastores" : [ {
      "version" : "8.1.3.200",
      "attachments" : {
        "min_cn" : 2,
        "max_cn" : 20
      }
    } ],
    "volume" : {
      "type" : "SSD",
      "size" : 160
    },
    "elastic_volume_specs" : [ {
      "type" : "SSD",
      "step" : 100,
      "min_size" : 100,
      "max_size" : 32000
    } ],
    "detail" : [ {
      "type" : "vCPU",
      "value" : "4"
    }, {
      "value" : "1675",
      "type" : "LOCAL_DISK",
      "unit" : "GB"
    }, {
      "type" : "mem",
      "value" : "32",
      "unit" : "GB"
    } ]
  } ],
  "count" : 1
}

SDK Sample Code

The sample code is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListNodeTypesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        ListNodeTypesRequest request = new ListNodeTypesRequest();
        try {
            ListNodeTypesResponse response = client.listNodeTypes(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListNodeTypesRequest()
        response = client.list_node_types(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListNodeTypesRequest{}
	response, err := client.ListNodeTypes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The node type is queried successfully.

400

Request error

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.