Creating a Host Cluster (Recommended)
Function
This API is used to create a host cluster in a project.
Calling Method
For details, see Calling APIs.
URI
POST /v1/resources/host-groups
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). |
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Parameter description: Host cluster name. Constraints: N/A Value range: The value consists of 3-128 characters. Only letters, digits,hyphens (-), underscores (_), and periods (.) are allowed. Default value: N/A |
project_id |
Yes |
String |
Parameter description: Project ID. For details, see [Obtaining a Project ID] (CloudDeploy_api_0014.xml). Constraints: N/A Value range: The value consists of 32 characters. Only letters and digits are allowed. Default value: N/A |
os |
Yes |
String |
Parameter description: OS of the host cluster. Constraints: N/A Value range:
Default value: N/A |
slave_cluster_id |
No |
String |
Parameter description: Slave cluster ID. If the ID is left empty, the official resource pool is used by default. The self-hosted resource pool is used when the self-hosted resource pool slave cluster ID is transferred. Constraints: N/A Value range: The value consists of 1-32 characters. Only letters and digits are allowed. Default value: N/A |
description |
No |
String |
Parameter description: Host cluster description. Constraints: N/A Value range: The value is a string of 0 to 500 characters. Default value: N/A |
is_proxy_mode |
Yes |
Integer |
Parameter description: Whether the host cluster is in the proxy mode. Constraints: N/A Value range:
Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Parameter description: Host cluster ID. Value range: The value consists of 32 characters. Only letters and digits are allowed. |
status |
String |
Parameter description: Request success or failure state. Value range:
|
Example Requests
When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.
https://{endpoint}/v1/resources/host-groups { "name" : "test123", "description" : "", "project_id" : "6039d4480efc4dddb178abff98719913", "os" : "linux", "slave_cluster_id" : "", "is_proxy_mode" : 1 }
Example Responses
Status code: 200
OK: The request is successful.
{ "status" : "success", "id" : "f3938bd63e354d2bb9d9cf7b5dc3bf95" }
SDK Sample Code
The SDK sample code is as follows.
Java
When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.
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 49 50 51 52 53 |
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 CreateHostClusterSolution { 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(); CreateHostClusterRequest request = new CreateHostClusterRequest(); CreateHostClusterRequestBody body = new CreateHostClusterRequestBody(); body.withIsProxyMode(1); body.withDescription(""); body.withSlaveClusterId(""); body.withOs(CreateHostClusterRequestBody.OsEnum.fromValue("linux")); body.withProjectId("6039d4480efc4dddb178abff98719913"); body.withName("test123"); request.withBody(body); try { CreateHostClusterResponse response = client.createHostCluster(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
When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.
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 |
# 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 = CreateHostClusterRequest() request.body = CreateHostClusterRequestBody( is_proxy_mode=1, description="", slave_cluster_id="", os="linux", project_id="6039d4480efc4dddb178abff98719913", name="test123" ) response = client.create_host_cluster(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
When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.
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 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.CreateHostClusterRequest{} descriptionCreateHostClusterRequestBody:= "" slaveClusterIdCreateHostClusterRequestBody:= "" request.Body = &model.CreateHostClusterRequestBody{ IsProxyMode: int32(1), Description: &descriptionCreateHostClusterRequestBody, SlaveClusterId: &slaveClusterIdCreateHostClusterRequestBody, Os: model.GetCreateHostClusterRequestBodyOsEnum().LINUX, ProjectId: "6039d4480efc4dddb178abff98719913", Name: "test123", } response, err := client.CreateHostCluster(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot