Halaman ini belum tersedia dalam bahasa lokal Anda. Kami berusaha keras untuk menambahkan lebih banyak versi bahasa. Terima kasih atas dukungan Anda.
Querying an Environment List of an Application
Function
This API is used to query an environment list of an application.
Calling Method
For details, see Calling APIs.
URI
GET /v1/applications/{application_id}/environments
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
application_id |
Yes |
String |
Definition: Application ID. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
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. |
page_index |
No |
Integer |
Definition: Page number, indicating that the query starts from this page. Constraints: N/A. Value range: [1–50]. Default value: N/A. |
page_size |
No |
Integer |
Definition: Number of records displayed on each page. Constraints: N/A. Value range: [1–100]. Default value: N/A. |
name |
No |
String |
Definition: Name of the environment to be queried. Constraints: N/A. Value range: Max. 128 characters. Default value: N/A. |
sort_key |
No |
String |
Definition: Sorting field. Constraints: N/A. Value range:
Default value: N/A. |
sort_dir |
No |
String |
Definition: Sorting order. Constraints: N/A. Value range:
Default value: N/A. |
Request 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
Parameter |
Type |
Description |
---|---|---|
status |
String |
Definition: Request status (successful or failed). Value range:
|
total |
Integer |
Definition: Number of environments that match requirements. Value range: 0–100. |
result |
Array of EnvironmentDetail objects |
Definition: Environment list information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Environment ID. Value range: 32 characters, including letters and digits. |
name |
String |
Definition: Environment name. Value range: N/A. |
description |
String |
Definition: Environment description. Value range: N/A. |
os |
String |
Definition: OS of environments. Value range:
|
project_id |
String |
Definition: Project ID. Value range: 32 characters, including letters and digits. |
nick_name |
String |
Definition: Nickname of the environment creator. Value range: N/A. |
deploy_type |
Integer |
Definition: Deployment type. Value range:
|
created_time |
String |
Definition: Environment creation time. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A. |
instance_count |
Integer |
Definition: Number of host instances in the environment. Value range: N/A. |
created_by |
UserInfo object |
Definition: Information about the environment creator, including the user ID and username. |
permission |
EnvironmentPermissionDetail object |
Definition: Environment operation permission matrix of the current user. |
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. |
Parameter |
Type |
Description |
---|---|---|
can_delete |
Boolean |
Definition: Whether you have the permission to delete environments. Value range:
|
can_deploy |
Boolean |
Definition: Whether you have the permission to deploy environments. Value range:
|
can_edit |
Boolean |
Definition: Whether you have permission to edit environments. Value range:
|
can_manage |
Boolean |
Definition: Whether you have permission to edit the environment permission matrix. Value range:
|
can_view |
Boolean |
Definition: Whether you have permission to view environments. Value range:
|
Example Requests
https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments?project_id=55837d272adf4eee90319800e2da6961
Example Responses
Status code: 200
OK: The request is successful.
{
"status" : "success",
"total" : 1,
"result" : [ {
"created_by" : {
"user_id" : "6baa7454109d47c192f22078fe6cda20",
"user_name" : "devcloud_devcloud_l00490255_01"
},
"created_time" : "2023-06-20 16:53:29.0",
"deploy_type" : 0,
"description" : "",
"id" : "a0a2274acc4f482bb2ecf49f865879fa",
"name" : "casdasd",
"project_id" : "55837d272adf4eee90319800e2da6961",
"nick_name" : "A/B Side Account",
"instance_count" : 1,
"os" : "linux",
"permission" : {
"can_delete" : true,
"can_deploy" : true,
"can_edit" : true,
"can_manage" : true,
"can_view" : true
}
} ]
}
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 46 |
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 ListEnvironmentsSolution {
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();
ListEnvironmentsRequest request = new ListEnvironmentsRequest();
request.withApplicationId("{application_id}");
try {
ListEnvironmentsResponse response = client.listEnvironments(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 31 |
# 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 = ListEnvironmentsRequest()
request.application_id = "{application_id}"
response = client.list_environments(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 36 |
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.ListEnvironmentsRequest{}
request.ApplicationId = "{application_id}"
response, err := client.ListEnvironments(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