هذه الصفحة غير متوفرة حاليًا بلغتك المحلية. نحن نعمل جاهدين على إضافة المزيد من اللغات. شاكرين تفهمك ودعمك المستمر لنا.

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Cloud Data Center
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
Domain Name Service
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
DataArts Studio
Data Warehouse Service
Cloud Search Service
DataArts Lake Formation
DataArts Fabric
Data Ingestion Service
Data Lake Visualization
Data Lake Factory
IoT
IoT Device Access
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
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Industry Video Management Service
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
Huawei Cloud Astro Canvas
Huawei Cloud Astro Zero
CodeArts Governance
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Business 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 (CCI)
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
Meeting
AI
ModelArts
PanguLargeModels
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Cloud Transformation
Cloud Adoption Framework
Well-Architected Framework
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
Blockchain
Blockchain Service
Web3 Node Engine Service
MacroVerse aPaaS
CloudDevice
KooDrive

Querying a Host Cluster List

Function

This API is used to query a host cluster list by specified criteria. This API will not be maintained after September 30, 2024. You can use the ListHostClusters API instead.

Calling Method

For details, see Calling APIs.

URI

GET /v2/host-groups

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

Default value:

N/A.

region_name

Yes

String

Definition:

Region ID.

Constraints:

N/A.

Value range:

Max. 255 characters, including letters, digits, hyphens (-), and underscores (_).

Default value:

N/A.

os

No

String

Definition:

OS of the host cluster.

Constraints:

N/A.

Value range:

  • window: Windows OS.

  • linux: Linux OS.

Default value:

N/A.

offset

No

Integer

Definition:

Offset from which the query starts.

Constraints:

N/A.

Value range:

0–2147483647

Default value:

0

limit

No

Integer

Definition:

Number of items displayed on each page.

Constraints:

N/A.

Value range:

1–1000

Default value:

1000

name

No

String

Definition:

Keyword in the host cluster name.

Constraints:

N/A.

Value range:

3 to 128 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

Default value:

N/A.

sort_key

No

String

Definition:

Sorting field query.

Constraints:

N/A.

Value range:

  • nick_name: Nickname.

  • name: Host cluster name.

Default value:

N/A.

sort_dir

No

String

Definition:

Sorting order.

Constraints:

N/A.

Value range:

  • desc: Descending order.

  • asc: Ascending order.

Default value:

desc

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Definition:

Number of host clusters.

Value range:

0–1,000.

host_groups

Array of DeploymentGroupDetail objects

Definition:

Host cluster list.

Table 4 DeploymentGroupDetail

Parameter

Type

Description

group_id

String

Definition:

Host cluster ID.

Value range:

32 characters, including letters and digits.

created_time

String

Definition:

Creation time. Format: yyyy-MM-dd HH:mm:ss.

Value range:

N/A.

updated_time

String

Definition:

Update time. Format: yyyy-MM-dd HH:mm:ss.

Value range:

N/A.

host_count

Integer

Definition:

Number of hosts in a cluster.

Value range:

0–200

project_name

String

Definition:

Project name.

Value range:

3 to 128 characters, including letters and digits.

name

String

Definition:

Host cluster name.

Value range:

3 to 128 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

region_name

String

Definition:

Region ID.

Value range:

Max. 255 characters, including letters, digits, hyphens (-), and underscores (_).

project_id

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Value range:

32 characters, including letters and digits.

os

String

Definition:

OS of the host cluster.

Value range:

  • window: Windows OS.

  • linux: Linux OS.

auto_connection_test_switch

Integer

Definition:

The automatic test function has been removed. This field is invalid.

Value range:

N/A.

slave_cluster_id

String

Definition:

Self-hosted agent pool ID.

Value range:

32 characters, including letters and digits.

nick_name

String

Definition:

Nickname of the creator.

Value range:

String. 1 to 30 characters.

created_by

UserInfo object

Parameter description:

Information about the creator, including the user ID and username.

updated_by

UserInfo object

Parameter description:

Information about the updater, including the user ID and username.

description

String

Definition:

Host cluster description.

Value range:

String. 0 to 500 characters.

permission

PermissionGroupDetail object

Parameter description:

Operation permission matrix of the current user on the host cluster.

Table 5 UserInfo

Parameter

Type

Description

user_id

String

Parameter description:

User ID.

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

user_name

String

Parameter description:

Username.

Value range:

The value consists of 1-255 characters. Only letters and digits are allowed.

Table 6 PermissionGroupDetail

Parameter

Type

Description

can_view

Boolean

Definition:

Whether you have the view permission.

Value range:

  • true: Yes.

  • false: No.

can_edit

Boolean

Definition:

Whether you have the edit permission.

Value range:

  • true: Yes.

  • false: No.

can_delete

Boolean

Definition:

Whether you have the delete permission.

Value range:

  • true: Yes.

  • false: No.

can_add_host

Boolean

Definition:

Whether you have permission to add hosts.

Value range:

  • true: Yes.

  • false: No.

can_manage

Boolean

Definition:

Whether you have the permission to manage the host cluster permission matrix.

Value range:

  • true: Yes.

  • false: No.

Example Requests

https://{endpoint}/v2/host-groups?region_name=region-a&project_id=6039d4480efc4dddb178abff98719913&offset=1&limit=10&sort_key=name&sort_dir=desc

Example Responses

Status code: 200

OK: The request is successful.

{
  "total" : 1,
  "host_groups" : [ {
    "name" : "testwyk",
    "description" : "11122211",
    "os" : "linux",
    "nick_name" : "A/B Side Account",
    "group_id" : "ab7647b0863c4e969c8949d38d591339",
    "region_name" : "region-a",
    "project_id" : "6039d4480efc4dddb178abff98719913",
    "permission" : {
      "can_view" : true,
      "can_edit" : true,
      "can_delete" : true,
      "can_add_host" : true,
      "can_manage" : true
    },
    "created_by" : {
      "user_id" : "6baa7454109d47c192f22078fe6cda20",
      "user_name" : "devcloud_devcloud_l00490255_01"
    },
    "updated_by" : {
      "user_id" : "6baa7454109d47c192f22078fe6cda20",
      "user_name" : "devcloud_devcloud_l00490255_01"
    },
    "auto_connection_test_switch" : 0,
    "slave_cluster_id" : "",
    "created_time" : "2021-04-01 17:05:53",
    "updated_time" : "2021-04-21 14:29:14",
    "host_count" : 1,
    "project_name" : null
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Java

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


public class ListHostGroupsSolution {

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

        CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>"))
                .build();
        ListHostGroupsRequest request = new ListHostGroupsRequest();
        try {
            ListHostGroupsResponse response = client.listHostGroups(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsdeploy.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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ListHostGroupsRequest()
        response = client.list_host_groups(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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"
    codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/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 := codeartsdeploy.NewCodeArtsDeployClient(
        codeartsdeploy.CodeArtsDeployClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

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
咨询盘古Doer

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback