更新时间:2025-07-23 GMT+08:00
分享

查询单个实例

功能介绍

查询单个实例信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

configuration_status

String

参数解释

配置状态。

取值范围

不涉及。

params_group_id

String

参数解释

参数组ID。

取值范围

不涉及。

type

String

参数解释

类型。

取值范围

不涉及。

subnet_id

String

参数解释

子网ID。

取值范围

不涉及。

role

String

参数解释

角色。

取值范围

不涉及。

internal_subnet_id

String

参数解释

内部子网ID。

取值范围

不涉及。

group

String

参数解释

分组信息。

取值范围

不涉及。

secure_group

String

参数解释

安全组。

取值范围

不涉及。

vpc

String

参数解释

VPC ID。

取值范围

不涉及。

azcode

String

参数解释

可用区编码。

取值范围

不涉及。

region

String

参数解释

局点编码。

取值范围

不涉及。

cluster_id

String

参数解释

集群ID。

取值范围

不涉及。

created

String

参数解释

创建时间。

取值范围

不涉及。

updated

String

参数解释

更新时间。

取值范围

不涉及。

status

String

参数解释

状态。

取值范围

不涉及。

name

String

参数解释

节点名称。

取值范围

不涉及。

links

Array of LinkResp objects

参数解释

链接信息。

取值范围

不涉及。

id

String

参数解释

节点ID。

取值范围

不涉及。

flavor

ClusterFlavorResp object

参数解释

规格信息。

取值范围

不涉及。

volume

CompatibleInstanceVolumeResp object

参数解释

容量。

取值范围

不涉及。

datastore

CompatibleDataStoreResp object

参数解释

版本信息。

取值范围

不涉及。

fault

CompatibleFaultResp object

参数解释

其它信息。

取值范围

不涉及。

configuration

CompatibleConfigurationResp object

参数解释

参数配置信息。

取值范围

不涉及。

locality

String

参数解释

废弃字段,无实际含义。

取值范围

不涉及。

replicas

Array of CompatibleReplicasResp objects

参数解释

废弃字段,无实际含义。

取值范围

不涉及。

db_user

String

参数解释

数据库用户。

取值范围

不涉及。

storage_engine

String

参数解释

存储引擎。

取值范围

不涉及。

pay_model

Integer

参数解释

付款方式。

取值范围

不涉及。

public_ip

String

参数解释

公网IP。

取值范围

不涉及。

traffic_ip

String

参数解释

流量IP。

取值范围

不涉及。

表3 ClusterFlavorResp

参数

参数类型

描述

id

String

参数解释

规格ID。

取值范围

不涉及。

links

Array of LinkResp objects

参数解释

链接信息。

取值范围

不涉及。

表4 CompatibleInstanceVolumeResp

参数

参数类型

描述

type

String

参数解释

类型。

取值范围

不涉及。

used

Float

参数解释

已使用空间。

取值范围

不涉及。

size

Integer

参数解释

总大小。

取值范围

不涉及。

表5 CompatibleDataStoreResp

参数

参数类型

描述

type

String

参数解释

数据库类型。

取值范围

不涉及。

version

String

参数解释

版本。

取值范围

不涉及。

表6 CompatibleFaultResp

参数

参数类型

描述

message

String

参数解释

信息。

取值范围

不涉及。

created

String

参数解释

创建者。

取值范围

不涉及。

details

String

参数解释

详细内容。

取值范围

不涉及。

表7 CompatibleConfigurationResp

参数

参数类型

描述

id

String

参数解释

参数组ID。

取值范围

不涉及。

name

String

参数解释

参数组名称。

取值范围

不涉及。

links

Array of LinkResp objects

参数解释

连接信息。

取值范围

不涉及。

表8 CompatibleReplicasResp

参数

参数类型

描述

id

String

参数解释

ID。

取值范围

不涉及。

name

String

参数解释

名称。

取值范围

不涉及。

links

Array of LinkResp objects

参数解释

链接。

取值范围

不涉及。

表9 LinkResp

参数

参数类型

描述

rel

String

参数解释

关联信息。

取值范围

不涉及。

href

String

参数解释

链接信息。

取值范围

不涉及。

请求示例

查询单个实例信息。

GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/instances/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90

响应示例

状态码:200

查询成功。

{
  "type" : "dws-cn",
  "role" : "Standalone",
  "group" : "cn-1",
  "vpc" : "28e65e71-0b08-4f04-a05f-1603f869cd1f",
  "azcode" : "cn-north-7c",
  "region" : "cn-north-7",
  "created" : "2025-05-11T10:07:06",
  "updated" : "2025-05-11T10:07:06",
  "status" : "ACTIVE",
  "name" : "dws-apie-dws-cn-cn-1-1",
  "links" : [ {
    "rel" : "self",
    "href" : ""
  }, {
    "rel" : "bookmark",
    "href" : ""
  } ],
  "id" : "a83ed6f4-8062-427f-81bc-1dd0546acb43",
  "flavor" : {
    "id" : "3228254e-81c6-4975-bb45-5d8365ab5f25",
    "links" : [ {
      "rel" : "self",
      "href" : ""
    }, {
      "rel" : "bookmark",
      "href" : ""
    } ]
  },
  "volume" : null,
  "datastore" : {
    "type" : "dws",
    "version" : "9.1.0.215"
  },
  "fault" : null,
  "configuration" : {
    "id" : "1fd0a140-c487-4b95-bf9a-243fe3d7468a",
    "name" : null,
    "links" : [ {
      "rel" : "self",
      "href" : ""
    }, {
      "rel" : "bookmark",
      "href" : ""
    } ]
  },
  "locality" : null,
  "replicas" : null,
  "configuration_status" : "In-Sync",
  "params_group_id" : "1fd0a140-c487-4b95-bf9a-243fe3d7468a",
  "subnet_id" : "b530bb2b-724b-477e-bd55-b4428ae91fdf",
  "internal_subnet_id" : "b37dceca-dec6-4128-8d57-abd0b6ce0cbe",
  "secure_group" : "cd15fdcd-c7d5-4660-bb78-30e701e80775",
  "cluster_id" : "bcdfb00c-a5e3-4896-83c7-3c397ed99f28",
  "db_user" : "dbadmin",
  "storage_engine" : null,
  "pay_model" : 0,
  "public_ip" : null,
  "traffic_ip" : "192.200.132.176"
}

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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ShowInstanceSolution {

    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);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowInstanceRequest request = new ShowInstanceRequest();
        request.withInstanceId("{instance_id}");
        try {
            ShowInstanceResponse response = client.showInstance(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 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.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ShowInstanceRequest()
        request.instance_id = "{instance_id}"
        response = client.show_instance(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"
    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")
    projectId := "{project_id}"

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

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

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

状态码

状态码

描述

200

查询成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档