获取环境参数分组列表
功能介绍
获取环境参数分组列表
调用方法
请参见如何调用API。
URI
GET /v1/projects/{project_id}/environments
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Long |
参数解释 起始偏移量,表示从此偏移量开始查询, offset大于等于0 约束限制 不涉及 取值范围 0-999 默认取值 不涉及 默认取值: 0 |
limit |
是 |
Long |
参数解释 每页显示的条目数量,最大支持200条 约束限制 不涉及 取值范围 1-200 默认取值 不涉及 默认取值: 200 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
environments |
Array of Environment objects |
参数解释 环境分组列表 |
offset |
Long |
参数解释 偏移量,表示从此偏移量开始查询,offset大于等于0 取值范围 0-999 |
limit |
Long |
参数解释 每页显示的条目数量,最大支持200条 取值范围 1-200 |
total_count |
Long |
参数解释 环境分组总条数 取值范围 0-100 |
参数 |
参数类型 |
描述 |
---|---|---|
environment_id |
String |
参数解释 环境分组id 取值范围 32个字符组成的字符串 |
environment_name |
String |
参数解释 环境分组名 取值范围 3-50个字符组成的字符串 |
environment_description |
String |
参数解释 环境分组描述 取值范围 0-300个字符组成的字符串 |
is_default |
Boolean |
参数解释 是否是默认环境 取值范围 false或者true,true表示为默认环境分组,false表示非默认环境分组 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-16个字符组成的字符串 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-100个字符组成的字符串 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
get https://{endpoint}/v1/projects/75681cbb7c324e15a9eb8ee74a96a474/environments?offset=1&limit=10
响应示例
状态码:200
获取环境参数分组列表返回体
{
"environments" : [ {
"environment_id" : "ff4893796ee1a8aa009ff3a470de55d8",
"environment_name" : "默认环境",
"environment_description" : "默认环境",
"is_default" : true
} ],
"offset" : 0,
"limit" : 1,
"total_count" : 50
}
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 |
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.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);
CloudtestClient client = CloudtestClient.newBuilder()
.withCredential(auth)
.withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
.build();
ListEnvironmentsRequest request = new ListEnvironmentsRequest();
request.withProjectId("{project_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 huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.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"]
credentials = BasicCredentials(ak, sk)
client = CloudtestClient.new_builder() \
.with_credentials(credentials) \
.with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ListEnvironmentsRequest()
request.project_id = "{project_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"
cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/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")
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
Build()
client := cloudtest.NewCloudtestClient(
cloudtest.CloudtestClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ListEnvironmentsRequest{}
request.ProjectId = "{project_id}"
response, err := client.ListEnvironments(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
获取环境参数分组列表返回体 |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。