查询企业项目列表
功能介绍
查询当前用户已授权的企业项目列表,用户可以使用企业项目绑定资源。
调用方法
请参见如何调用API。
URI
GET /v1.0/enterprise-projects
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
企业项目ID,0表示默认企业项目 |
name |
否 |
String |
企业项目名称,支持模糊搜索 |
status |
否 |
Integer |
企业项目状态。 1--启用,2--停用 |
limit |
否 |
Integer |
查询记录数默认为1000,limit最多为1000, 最小值为1 |
offset |
否 |
Integer |
索引位置,从offset指定的下一条数据开始查询,必须为数字,不能为负数,默认为0 |
sort_key |
否 |
String |
返回结果按该关键字排序(支持updated_at,name等关键字,默认为“created_at”) |
sort_dir |
否 |
String |
降序或升序,默认为“desc” 。desc表示降序 。asc 表示升序 |
type |
否 |
String |
查询项目类型 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。说明:由于EPS是全局服务,因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。 |
X-Domain-Id |
是 |
String |
用户domainId。说明:如果用户使用aksk调用,则需要传入该参数。 |
X-Region-From |
否 |
String |
说明:如果用户region级token,则需要传入该参数。 |
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
enterprise_projects |
Array of EpDetail objects |
企业项目列表 |
total_count |
Integer |
企业项目总数 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
企业项目ID |
name |
String |
企业项目名称 |
description |
String |
企业项目描述 |
status |
Integer |
企业项目状态。1启用,2停用 |
created_at |
String |
创建时间,格式为UTC格式。如:2018-05-18T06:49:06Z。 |
updated_at |
String |
修改时间,格式为UTC格式。如:2018-05-28T02:21:36Z。 |
type |
String |
项目类型。prod-商用项目;poc-测试项目 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 402
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 405
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 406
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 407
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 408
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 409
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 501
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 502
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 503
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
状态码: 504
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
错误请求信息 |
请求示例
无
响应示例
状态码: 200
OK
{ "enterprise_projects" : [ { "id" : "6fbcf2f3-3164-4d32-9a3e-a8886dc38c24", "name" : "auto_test", "description" : "hello world!", "status" : 1, "type" : "prod", "created_at" : "2018-05-18T06:49:06Z", "updated_at" : "2018-05-28T02:21:36Z" } ], "total_count" : 1 }
SDK代码示例
SDK代码示例如下。
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.GlobalCredentials; 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.eps.v1.region.EpsRegion; import com.huaweicloud.sdk.eps.v1.*; import com.huaweicloud.sdk.eps.v1.model.*; public class ListEnterpriseProjectSolution { 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 GlobalCredentials() .withAk(ak) .withSk(sk); EpsClient client = EpsClient.newBuilder() .withCredential(auth) .withRegion(EpsRegion.valueOf("<YOUR REGION>")) .build(); ListEnterpriseProjectRequest request = new ListEnterpriseProjectRequest(); try { ListEnterpriseProjectResponse response = client.listEnterpriseProject(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()); } } } |
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 GlobalCredentials from huaweicloudsdkeps.v1.region.eps_region import EpsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeps.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 = GlobalCredentials(ak, sk) client = EpsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EpsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListEnterpriseProjectRequest() response = client.list_enterprise_project(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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/global" eps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := eps.NewEpsClient( eps.EpsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListEnterpriseProjectRequest{} response, err := client.ListEnterpriseProject(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
402 |
Payment Required |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
406 |
Not Acceptable |
407 |
Proxy Authentication Required |
408 |
Request Timeout |
409 |
Conflict |
500 |
Internal Server Error |
501 |
Not Implemented |
502 |
Bad Gateway |
503 |
Service Unavailable |
504 |
Gateway Timeout |
错误码
请参见错误码。