更新时间:2024-09-12 GMT+08:00
分享

HTAP查询规格信息

功能介绍

HTAP查询规格信息。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/htap/flavors/{engine_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

engine_name

String

HTAP引擎名。

取值范围:

  • star-rocks

  • click-house

表2 Query参数

参数

是否必选

参数类型

描述

availability_zone_mode

String

可用区模式,当前仅支持single。

spec_code

String

规格码,提供后仅查询指定规格码规格信息。

version_name

String

数据库版本号,不填默认3.1.6.0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

Content-Type

String

内容类型。 取值:application/json。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us

  • zh-cn

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

flavors

Array of flavors objects

规格信息。

表5 flavors

参数

参数类型

描述

type

String

规格类型,取值为arm、x86和generalX86。

arm:独享型arm规格。

x86:独享型x86规格。

generalX86:通用型X86规格。

vcpus

String

CPU大小。例如:1表示1U。

ram

String

内存大小,单位为GB。

id

String

规格ID,该字段唯一。

spec_code

String

资源规格编码,.同创建指定的flavor_ref。例如:gaussdb.sr-be.xlarge.x86.4。

“gaussdb.sr”代表产品。

“xlarge” 代表计算规格为4U。

“x86” 代表CPU架构为x86。

“4” 表示vCPU和内存为1:4。

version_name

String

数据库版本号。

instance_mode

String

实例类型。目前仅支持Cluster、Single。

az_status

Map<String,String>

规格所在AZ的状态,包含以下状态:

normal:在售。

unsupported:暂不支持该规格。

sellout:售罄。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询StarRocks规格信息

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/htap/flavors/star-rocks?availability_zone_mode=single

响应示例

状态码: 200

Success.

{
  "flavors" : [ {
    "type" : "x86",
    "vcpus" : "4",
    "ram" : "16",
    "id" : "de565db8-0a96-37ea-9388-61167624712c",
    "spec_code" : "gaussdb.sr-be.xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "4",
    "ram" : "16",
    "id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
    "spec_code" : "gaussdb.sr-fe.xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "8",
    "ram" : "32",
    "id" : "c50e8e15-f2fc-3b40-aca6-c98f07ce2ce0",
    "spec_code" : "gaussdb.sr-be.2xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "8",
    "ram" : "32",
    "id" : "24059750-4280-3ee5-a44b-488b924633b4",
    "spec_code" : "gaussdb.sr-fe.2xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "16",
    "ram" : "64",
    "id" : "a48c63dc-5563-3813-9e13-39d3301e56f4",
    "spec_code" : "gaussdb.sr-be.4xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "16",
    "ram" : "64",
    "id" : "0ef44c01-f7a1-30f5-9f05-9e47094e8c1f",
    "spec_code" : "gaussdb.sr-fe.4xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "32",
    "ram" : "128",
    "id" : "2bf6aa50-50da-3f27-91af-a8c873070537",
    "spec_code" : "gaussdb.sr-fe.8xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "normal"
    }
  }, {
    "type" : "x86",
    "vcpus" : "32",
    "ram" : "128",
    "id" : "9f52a065-aa93-371a-9975-959fedf6e24f",
    "spec_code" : "gaussdb.sr-be.8xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "normal"
    }
  }, {
    "type" : "x86",
    "vcpus" : "64",
    "ram" : "256",
    "id" : "709822e4-567f-3e85-b4af-cb099206c8e2",
    "spec_code" : "gaussdb.sr-fe.16xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "64",
    "ram" : "256",
    "id" : "4e56e208-0226-34bb-b84d-035ab0497824",
    "spec_code" : "gaussdb.sr-be.16xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "unsupported"
    }
  } ]
}

状态码: 400

Client error.

{
  "error_msg" : "Invalid specification code.",
  "error_code" : "DBS.280434"
}

SDK代码示例

SDK代码示例如下。

 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
46
47
48
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.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;


public class ListHtapFlavorSolution {

    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");
        String projectId = "{project_id}";

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

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ListHtapFlavorRequest request = new ListHtapFlavorRequest();
        request.withEngineName("{engine_name}");
        try {
            ListHtapFlavorResponse response = client.listHtapFlavor(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
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 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.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListHtapFlavorRequest()
        request.engine_name = "{engine_name}"
        response = client.list_htap_flavor(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
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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")
    projectId := "{project_id}"

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

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档