Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying HTAP Instances

Function

This API is used to query HTAP instances. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/htap

Table 1 URI 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.

instance_id

Yes

String

TaurusDB instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Content-Type

Yes

String

Content type. Value: application/json

X-Language

No

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Number of HTAP instances.

instances

Array of instances objects

HTAP instance information.

max_htap_instance_num_of_taurus

Integer

Maximum number of HTAP instances that can be created.

Table 4 instances

Parameter

Type

Description

id

String

HTAP instance ID, which is compliant with the UUID format.

name

String

HTAP instance name.

engine_name

String

HTAP DB engine name.

engine_version

String

HTAP DB engine version.

project_id

String

Project ID of a tenant in a region.

instance_state

instance_state object

HTAP instance status information.

create_at

Long

Time when the HTAP instance was created.

is_frozen

Boolean

Whether the HTAP instance is frozen.

ha_mode

String

HTAP instance deployment mode.

pay_model

String

Billing mode. Only pay-per-use billing is supported.

  • 0: pay-per-use
  • 1: yearly/monthly

order_id

String

Order ID for the yearly/monthly subscription.

alter_order_id

String

Alternative order ID for the yearly/monthly subscription.

data_vip

String

Private IP address.

readable_node_infos

Array of ReadableNodeInfos objects

Readable node information.

proxy_ips

Array of strings

Proxy IP address.

data_vip_v6

String

Private IPv6 address.

port

Integer

Database port.

available_zones

Array of available_zones objects

AZ information.

current_actions

Array of QueryAction objects

Instance actions.

volume_type

String

Storage type.

server_type

String

Server type.

enterprise_project_id

String

Enterprise project ID. This parameter is mandatory when the enterprise project is enabled.

dedicated_resource_id

String

Dedicated resource pool ID. This parameter is displayed only when the dedicated resource pool is enabled.

network

network object

Network information.

ch_master_node_id

String

ClickHouse primary node ID.

node_num

Integer

Number of nodes.

Table 5 instance_state

Parameter

Type

Description

instance_status

String

HTAP instance status.

create_fail_error_code

String

Error code for HTAP instance creation failure.

fail_message

String

Error message for HTAP instance creation failure.

wait_restart_for_params

Boolean

Whether a reboot is required for parameter updates.

Table 6 ReadableNodeInfos

Parameter

Type

Description

data_ip

String

IP address of the readable node.

node_id

String

ID of the readable node.

node_name

String

Name of the readable node.

Table 7 available_zones

Parameter

Type

Description

code

String

AZ code.

description

String

AZ description.

az_type

String

AZ type.

Table 8 QueryAction

Parameter

Type

Description

id

String

Instance or node action ID.

action

String

Instance or node action name.

object_id

String

Object ID of the instance or node action.

type

String

Instance or node action type.

job_id

String

Task ID of the instance or node action.

status

String

Instance or node action status.

Enumerated values:

  • OK_TO_RUN
  • DELETED

created_at

Long

Time when the instance or node action was created.

updated_at

Long

Time when the instance or node action was updated.

Table 9 network

Parameter

Type

Description

vpc_id

String

VPC ID.

sub_net_id

String

Subnet ID.

security_group_id

String

Security group ID.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying HTAP instances of a TaurusDB instance

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/18c3eeb7b788479eb8b93b209946a83bin07/htap

Example Response

Status code: 200

Success.

{
  "total" : 4,
  "instances" : [ {
    "id" : "bfc970d8e9b34a399b4c422aabe11409in17",
    "name" : "htap-fjld",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711094408228,
    "is_frozen" : false,
    "ha_mode" : "Single",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.207",
    "data_ips" : {
      "node_ip" : "192.168.0.207",
      "node_id" : "36d62cd6a77a4e80a335077867e7912bno16",
      "node_name" : "htap-1244_shard01_node01"
    },
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "cn-southwest-244b",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 2
  }, {
    "id" : "656c539296bd47b49fe29983368b9fb2in17",
    "name" : "HTAP-1711093893",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711094228737,
    "is_frozen" : false,
    "ha_mode" : "Single",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.201",
    "data_ips" : [ "192.168.0.201" ],
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "az",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 2
  }, {
    "id" : "04c48d11f0d24c8d8aee254981a3b94fin17",
    "name" : "htap-fjlc",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711075260516,
    "is_frozen" : false,
    "ha_mode" : "Cluster",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.249",
    "data_ips" : [ "192.168.0.183", "192.168.0.7", "192.168.0.41" ],
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "az",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 6
  }, {
    "id" : "f2d2441a88384023b2e30f0b600a0013in17",
    "name" : "htap-fjlb",
    "engine_name" : "star-rocks",
    "engine_version" : "3.1.6",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "instance_state" : {
      "instance_status" : "normal",
      "create_fail_error_code" : null,
      "fail_message" : null,
      "wait_restart_for_params" : false
    },
    "create_at" : 1711021269903,
    "is_frozen" : false,
    "ha_mode" : "Single",
    "pay_model" : "0",
    "order_id" : null,
    "alter_order_id" : "",
    "data_vip" : "192.168.0.209",
    "data_ips" : [ "192.168.0.151", "192.168.0.209" ],
    "proxy_ips" : [ ],
    "data_vip_v6" : null,
    "port" : 3306,
    "available_zones" : [ {
      "code" : "cn-southwest-244b",
      "description" : "az2",
      "az_type" : "Center"
    } ],
    "current_actions" : [ ],
    "volume_type" : "SSD",
    "server_type" : "KVM",
    "enter_prise_project_id" : "0",
    "dedicated_resource_id" : "",
    "network" : {
      "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
      "sub_net_id" : "8926baca-467a-4556-8603-b4077805ff9d",
      "security_group_id" : ""
    },
    "ch_master_node_id" : null,
    "node_num" : 2
  } ],
  "max_htap_instance_num_of_taurus" : 10
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback