Updated on 2022-06-16 GMT+08:00

Querying the Supported Node Types

Function

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

URI

  • URI format
    GET /v1.0/{project_id}/node_types
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

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

Request Message

  • Sample request
    GET /v1.0/89cd04f168b84af6be287f71730fdb4b/node_types

Response Message

  • Sample response
    status CODE 200
    {
        "node_types": [
            {
                "spec_name": "dws.d1.xlarge",
                "id": "ebe532d6-665f-40e6-a4d4-3c51545b6a67",
                "detail": [
                    {
                        "type": "vCPU", 
                        "value": "4"
                    },
                    {
                        "value": "1675",
                        "type": "LOCAL_DISK",
                        "unit": "GB"
                    },
                    {
                        "type": "mem",
                        "value": "32",
                        "unit": "GB"
                    }
                ]
            },
            {
                "spec_name": "dws.m1.xlarge.ultrahigh",
                "id": "ebe532d6-665f-40e6-a4d4-3c51545b4f71",
                "detail": [
                    {
                        "type": "vCPU",
                        "value": "4"
                    },
                    {
                        "value": "512",
                        "type": "SSD",
                        "unit": "GB"
                    },
                    {
                        "type": "mem",
                        "value": "32",
                        "unit": "GB"
                    }
                ]
            }
        ]
    }
  • Parameter description
    Table 2 Response parameter description

    Parameter

    Type

    Description

    node_types

    Array of NodeTypes objects

    List of node types

    Table 3 NodeTypes

    Parameter

    Type

    Description

    detail

    Detail object

    Node type details

    id

    String

    Node type ID

    spec_name

    String

    Name of a node type

    Table 4 Detail

    Parameter

    Type

    Description

    unit

    String

    Attribute unit

    type

    String

    Attribute type

    value

    String

    Attribute value

Status Code

  • Normal

    200

  • Abnormal
    Table 5 Returned value description

    Returned Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    You do not have the permission to perform the operation.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    The service is unavailable.