查询应用下环境列表
功能介绍
查询应用下环境列表。
调用方法
请参见如何调用API。
URI
GET /v1/applications/{application_id}/environments
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
application_id |
是 |
String |
应用id 最小长度:32 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 最小长度:32 最大长度:32 |
page_index |
否 |
Integer |
分页页码,表示从此页开始查询,page大于等于1 最小值:1 最大值:50 缺省值:1 |
page_size |
否 |
Integer |
每页显示的条目数量,size小于等于100 最小值:1 最大值:100 缺省值:100 |
name |
否 |
String |
要查询的环境名称 最大值:128 |
sort_key |
否 |
String |
排序字段,支持按照环境名称|用户名称|创建时间|用户昵称排序 缺省值:CREATED_TIME 枚举值:
|
sort_dir |
否 |
String |
排序顺序,DESC降序,ASC升序 缺省值:DESC 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:0 最大长度:20000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
响应状态 |
total |
Integer |
应用下环境总数 |
result |
Array of EnvironmentDetail objects |
环境列表信息 数组长度:0 - 100 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
环境id |
name |
String |
环境名称 |
description |
String |
环境描述 |
os |
String |
操作系统 |
nick_name |
String |
用户昵称 |
deploy_type |
Integer |
部署类型:0表示主机, 1表示kubernetes |
created_time |
String |
创建时间 |
instance_count |
Integer |
环境下主机实例数量 |
created_by |
UserInfo object |
用户信息 |
permission |
EnvironmentPermissionDetail object |
环境权限详情 |
请求示例
https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments?project_id=55837d272adf4eee90319800e2da6961
响应示例
状态码: 200
OK 请求响应成功
{ "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", "nick_name" : "AB边账号", "os" : "linux", "permission" : { "can_delete" : true, "can_deploy" : true, "can_edit" : true, "can_manage" : true, "can_view" : true } } ] }
SDK代码示例
SDK代码示例如下。
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 47 48 49 50 51 |
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.withProjectId("<project_id>"); request.withPageIndex(<page_index>); request.withPageSize(<page_size>); request.withName("<name>"); request.withSortKey(ListEnvironmentsRequest.SortKeyEnum.fromValue("<sort_key>")); request.withSortDir(ListEnvironmentsRequest.SortDirEnum.fromValue("<sort_dir>")); 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 32 33 34 35 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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.project_id = "<project_id>" request.page_index = <page_index> request.page_size = <page_size> request.name = "<name>" request.sort_key = "<sort_key>" request.sort_dir = "<sort_dir>" 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 37 38 39 40 41 42 43 44 45 46 |
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.ProjectId = "<project_id>" pageIndexRequest:= int32(<page_index>) request.PageIndex = &pageIndexRequest pageSizeRequest:= int32(<page_size>) request.PageSize = &pageSizeRequest nameRequest:= "<name>" request.Name = &nameRequest sortKeyRequest:= model.GetListEnvironmentsRequestSortKeyEnum().<SORT_KEY> request.SortKey = &sortKeyRequest sortDirRequest:= model.GetListEnvironmentsRequestSortDirEnum().<SORT_DIR> request.SortDir = &sortDirRequest response, err := client.ListEnvironments(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。