更新时间:2024-03-07 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。

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

{
  "configuration_status" : "In-Sync",
  "params_group_id" : "53cb2c86-a598-58ca-8c2c-0389f4b78912",
  "type" : "dws-cn",
  "subnet_id" : "43cb2c86-a598-59ca-8c2c-0380f4b78613",
  "role" : "Standalone",
  "internal_subnet_id" : "73cb3c86-a598-59ca-8c2c-0380f4b78659",
  "group" : "cn-1",
  "secure_group" : null,
  "vpc" : "62cb2c86-a598-58ca-8c2c-0389f4b78954",
  "azcode" : "cn-north-854a",
  "region" : "cn-north-854",
  "cluster_id" : "85cb3c86-a598-59ca-8c2c-0380f4b78613",
  "created" : "2023-02-24T02:25:36",
  "updated" : "2023-02-24T09:25:36",
  "status" : null,
  "name" : "test-dws-cn-cn-1-1",
  "links" : [ {
    "rel" : "self",
    "href" : null
  }, {
    "rel" : "bookmark",
    "href" : null
  } ],
  "id" : "13cb2c86-a598-48ca-8c2c-0389f4b78963",
  "flavor" : {
    "id" : "46cb2c86-a598-48ca-8c2c-0389f4b78545",
    "links" : [ {
      "rel" : "self",
      "href" : null
    }, {
      "rel" : "bookmark",
      "href" : null
    } ]
  },
  "volume" : null,
  "datastore" : {
    "type" : "dws3.0",
    "version" : "9.0.0"
  },
  "fault" : null,
  "configuration" : {
    "id" : "56cb2c86-a598-48ca-8c2c-0389f4b78549",
    "name" : "test",
    "links" : [ {
      "rel" : "self",
      "href" : null
    }, {
      "rel" : "bookmark",
      "href" : null
    } ]
  },
  "locality" : null,
  "replicas" : null,
  "db_user" : "admin",
  "storage_engine" : null,
  "pay_model" : 0,
  "public_ip" : null,
  "traffic_ip" : "192.168.13.132"
}

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

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        ShowInstanceRequest request = new ShowInstanceRequest();
        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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ShowInstanceRequest()
        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
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")

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

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ShowInstanceRequest{}
	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

服务不可用。

相关文档