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 Details of a DB Instance

Updated on 2025-02-10 GMT+08:00

Function

This API is used to query the details of a specified DB instance. Before calling this API:

NOTICE:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Querying Details of a DB Instance) before then.

URI

  • URI format

    GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}

  • Example

    GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

  • Parameter description
    Table 1 Parameter description

    Name

    Type

    Mandatory

    Description

    project_id

    String

    Yes

    Project ID of a tenant in a region.

    To obtain this value, see Obtaining a Project ID.

    instance_id

    String

    Yes

    DB instance ID.

Request

None.

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    instance

    Object

    Instance information.

    For details, see Table 3.

    Table 3 instance field data structure description

    Name

    Type

    Description

    id

    String

    DB instance ID.

    name

    String

    DB instance name.

    project_id

    String

    Project ID of a tenant in a region.

    status

    String

    DB instance status.

    Values:

    If the value is BUILD, the DB instance is being created.

    If the value is ACTIVE, the DB instance is normal.

    If the value is FAILED, the DB instance is abnormal.

    If the value is FROZEN, the DB instance is frozen.

    If the value is MODIFYING, the DB instance is being scaled up.

    If the value is REBOOTING, the DB instance is being rebooted.

    If the value is RESTORING, the DB instance is being restored.

    If the value is MODIFYING INSTANCE TYPE, the DB instance is changing from primary to standby.

    If the value is SWITCHOVER, the primary/standby switchover is being performed.

    If the value is MIGRATING, the DB instance is being migrated.

    If the value is BACKING UP, the DB instance is being backed up.

    If the value is MODIFYING DATABASE PORT, the database port is being changed.

    If the value is STORAGE FULL, the instance storage space is full.

    enterprise_project_id

    String

    Enterprise project ID.

    type

    String

    DB instance type. Currently, only the cluster type is supported.

    node_count

    Integer

    Number of nodes.

    datastore

    Object

    Database information. For details, see Table 4.

    backup_used_space

    Double

    Used backup space in GB.

    created

    String

    Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800. The value is empty unless the instance creation is complete.

    updated

    String

    Update time. The format is the same as that of the created field. The value is empty unless the instance creation is complete.

    public_ips

    String

    Public IP address of the instance.

    private_write_ips

    Array of List

    Private IP address for write.

    db_user_name

    String

    Default username.

    port

    String

    Database port.

    vpc_id

    String

    VPC ID.

    subnet_id

    String

    Network ID of the subnet.

    security_group_id

    String

    Security group ID.

    volume

    Object

    Disk information. For details, see Table 7.

    backup_strategy

    Object

    Backup policy. For details, see Table 5.

    nodes

    Arrays of object

    Node information. For details, see Table 6.

    time_zone

    String

    Time zone.

    az_mode

    String

    AZ type. It can be single or multi.

    master_az_code

    String

    Primary AZ.

    maintenance_window

    String

    Maintenance window in the UTC format.

    configuration_id

    String

    ID of the parameter template used for creating an instance or ID of the latest parameter template that is applied to an instance.

    tags

    Arrays of object

    Tags for managing instances. For details, see Table 8.

    Table 4 datastore field data structure description

    Name

    Type

    Description

    type

    String

    DB engine.

    version

    String

    DB version.

    Table 5 backup_strategy field data structure description

    Name

    Type

    Description

    start_time

    String

    Backup time window. Automated backups will be triggered during the backup time window.

    keep_days

    Integer

    Backup retention days.

    Table 6 nodes field data structure description

    Name

    Type

    Description

    id

    String

    Node ID.

    name

    Array of object

    Node name.

    type

    String

    Node type, which can be master or slave.

    status

    String

    Node status.

    port

    Integer

    Database port.

    private_read_ips

    Array of String

    Private IP address for read.

    volume

    Object

    Disk information.

    az_code

    String

    AZ.

    region_code

    String

    Region where the DB instance is deployed.

    created

    String

    DB instance creation time.

    updated

    String

    Update time.

    flavor_ref

    String

    Specification code.

    For details, see Table 3.

    max_connections

    String

    Maximum number of connections.

    vcpus

    String

    Number of vCPUs.

    ram

    String

    Memory size in GB.

    need_restart

    Boolean

    Whether to reboot the DB instance for the modifications to take effect.

    priority

    String

    Failover priority.

    Table 7 volume field data structure description

    Name

    Type

    Description

    type

    String

    Storage type. Currently, only POOL is supported.

    used

    String

    Used storage size in GB.

    Table 8 tags field data structure description

    Name

    Type

    Description

    type

    String

    Tag key. The value can contain a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

    used

    String

    Tag value. The value contains a maximum of 43 Unicode characters and can also be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

    NOTE:

    The values of region_code and az_code are used as examples.

  • Example normal response
    {
      "instance": {
        "id": "d2cda7b97a39488e8b30e3cea4066204in07",
        "name": "gauss-d616-lb07",
        "status": "FAILED",
        "project_id": "053f533ead80d5102f0cc012e8d468a4",
        "enterprise_project_id": "0",
        "type": "Cluster",
        "charge_info": {
          "charge_mode": "postPaid",
          "order_id": ""
        },
        "node_count": 2,
        "datastore": {
          "type": "GaussDB(for MySQL)",
          "version": "8.0"
        },
        "created": "2020-07-21T09:13:56+0800",
        "updated": "2020-07-21T09:27:54+0800",
        "public_ips": "",
        "private_write_ips": [
          "192.168.0.235"
        ],
        "db_user_name": "root",
        "port": "3306",
        "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
        "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
        "security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902",
        "backup_strategy": {
          "start_time": "00:00-00:00",
          "keep_days": "0"
        },
        "nodes": [
          {
            "id": "799a0f2fa49a4151bf9f7063c1fbba36no07",
            "name": "gauss-d616-lb07_node01",
            "type": "master",
            "status": "FAILED",
            "port": 3306,
            "private_read_ips": [
              "192.168.0.163"
            ],
            "volume": {
              "type": "POOL",
              "used": "0.0"
            },
            "az_code": "az1xahz",
            "region_code": "cn-xianhz-1",
            "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
            "flavor_ref": "gaussdb.large.4",
            "max_connections": null,
            "vcpus": "1",
            "ram": "4",
            "need_restart": false,
            "priority": 1
          },
          {
            "id": "816459d771c444db9fa4c1d5c173cb1cno07",
            "name": "gauss-d616-lb07_node02",
            "type": "slave",
            "status": "FAILED",
            "port": 3306,
            "private_read_ips": [
              "192.168.0.160"
            ],
            "volume": {
              "type": "POOL",
              "used": "0.0"
            },
            "az_code": "az1xahz",
            "region_code": "cn-xianhz-1",
            "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
            "flavor_ref": "gausssdb.large.4",
            "max_connections": null,
            "vcpus": "1",
            "ram": "4",
            "need_restart": false,
            "priority": 1
          }
        ],
        "time_zone": "UTC+08:00",
        "backup_used_space": 0,
        "az_mode": "single",
        "master_az_code": "az1xahz",
        "maintenance_window": "18:00-22:00"
      }
    }

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