更新时间:2024-11-06 GMT+08:00

查询集群详情信息列表

功能介绍

查询集群详情信息列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/service/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询条数限制。

offset

Integer

查询起始坐标。

name

String

集群名称,该参数为模糊匹配。

create_user

String

创建人名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

Dlm-Type

String

数据服务的版本类型,指定SHARED共享版或EXCLUSIVE专享版。

Content-Type

String

消息体的类型(格式),有Body体的情况下必选,没有Body体无需填写。如果请求消息体中含有中文字符,则需要通过charset=utf8指定中文字符集,例如取值为:application/json;charset=utf8。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

集群数量。

instances

Array of InstanceDetailDTO objects

集群概览信息。

表5 InstanceDetailDTO

参数

参数类型

描述

id

String

集群ID。

name

String

集群名称。

description

String

集群描述信息。

external_address

String

公网IP地址。

intranet_address

String

内网IPv4地址。

intranet_address_ipv6

String

内网IPv6地址。

public_zone_id

String

公网域名ID。

public_zone_name

String

公网域名名称。

private_zone_id

String

内网域名ID。

private_zone_name

String

内网域名名称。

enterprise_project_id

String

企业项目ID。

create_time

Long

创建时间。

create_user

String

创建人。

current_namespace_publish_api_num

Integer

当前工作空间已发布的API数量。

all_namespace_publish_api_num

Integer

所有工作空间已发布的API数量。

api_publishable_num

Integer

集群API总配额。

deletable

Boolean

集群是否可以删除。

charge_status

String

集群计费状态,NO_CHARGE:未计费、CHARGED:已计费,GRACE:宽限期、RETENTION:保留期。

order_id

String

订单ID。

order_type

String

订单类型,PERIOD:包周期、ON_DEMAND:按需。

period_type

String

集群订购周期类型。

instance_status

String

集群状态。

node_num

Integer

节点数量。

flavor

FlavorDTO object

集群节点规格。

gateway_version

String

集群版本号。

availability_zone

String

集群所在可用区编码。

availability_zone_name

String

集群所在可用区名称。

vpc_id

String

集群所在虚拟私有云ID。

subnet_id

String

集群所在子网ID。

security_group_id

String

集群所在安全组ID。

nodes

Array of InstanceNodeDTO objects

集群节点列表。

表6 FlavorDTO

参数

参数类型

描述

id

String

规格ID。

name

String

规格名称。

disk

Integer

磁盘大小。

cpu

Integer

CPU大小。

mem

Integer

内存大小。

表7 InstanceNodeDTO

参数

参数类型

描述

id

String

节点ID。

name

String

节点名称。

private_ip

String

节点IP地址。

status

String

节点状态。

create_user

String

节点创建人。

create_time

String

节点创建时间。

gateway_version

String

节点版本号。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询集群详情信息列表。

/v1/0833a5737480d53b2f250010d01a7b88/service/instances

响应示例

状态码: 200

查询成功。

{
  "total" : 1,
  "instances" : [ {
    "node_num" : 1,
    "flavor" : {
      "id" : "95d4e992-6e3c-11ea-8e90-fa163e35",
      "name" : "测试专用小规格(X86)",
      "disk" : 120,
      "cpu" : 8,
      "mem" : 16
    },
    "gateway_version" : "3.0.5",
    "availability_zone" : "cn-north-7c",
    "availability_zone_name" : "可用区3",
    "vpc_id" : "791a1ee9-aacf-477a-b00e-dfb18aa364eb",
    "subnet_id" : "43de865d-e4ce-48c3-8c92-f4972026f4c4",
    "security_group_id" : "e7527b7f-03d2-49b8-9e78-f4fc3886e792",
    "nodes" : [ {
      "id" : "49fdf486-af68-4967-8d96-2aca93dc2dbb",
      "name" : "dlm_HCS_20240205-dayu_dlm-instance-1-1",
      "private_ip" : "192.168.0.130",
      "status" : "RUNNING",
      "create_user" : "user",
      "create_time" : "2024-02-20T03:59:25Z",
      "gateway_version" : "3.0.5"
    } ],
    "id" : "c830776ec23fdffe237a44845f871180",
    "name" : "dlm_HCS_20240205",
    "description" : "",
    "external_address" : "100.85.122.140",
    "intranet_address" : "192.168.0.157",
    "intranet_address_ipv6" : "2407:c080:11f0:535:8b8f:1825:a0d8:669",
    "private_zone_id" : null,
    "private_zone_name" : null,
    "public_zone_id" : null,
    "public_zone_name" : null,
    "instance_status" : "RUNNING",
    "enterprise_project_id" : "0",
    "create_time" : 1708400912000,
    "create_user" : "user",
    "current_namespace_publish_api_num" : null,
    "all_namespace_publish_api_num" : null,
    "api_publishable_num" : null,
    "deletable" : true,
    "charge_status" : "CHARGED",
    "period_type" : "ABSOLUTE",
    "order_type" : "ON_DEMAND",
    "order_id" : null
  } ]
}

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
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.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ListDataServiceInstancesDetailSolution {

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

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListDataServiceInstancesDetailRequest request = new ListDataServiceInstancesDetailRequest();
        try {
            ListDataServiceInstancesDetailResponse response = client.listDataServiceInstancesDetail(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 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 = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListDataServiceInstancesDetailRequest()
        response = client.list_data_service_instances_detail(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/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 := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

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

状态码

状态码

描述

200

查询成功。

400

BadRequest。