On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Enterprise Management/ API Reference/ Enterprise Project Management APIs/ Enterprise Project Management/ Listing Enterprise Projects

Listing Enterprise Projects

Updated on 2024-01-09 GMT+08:00

View PDF

Function

This API is used to query the list of enterprise projects that can be managed by a user. The user can add resources to an enterprise project in the list.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/enterprise-projects

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
id	No	String	Enterprise project ID. The value 0 indicates the default enterprise project.
name	No	String	Enterprise project name. Fuzzy search is supported.
status	No	Integer	Enterprise project status. 1: enabled; 2: disabled.
limit	No	Integer	The default number of records to be queried is 1000. The maximum value is 1000 and the minimum value is 1.
offset	No	Integer	Index position. The query starts from the next data record specified by offset. The value must be a number and cannot be a negative number. The default value is 0.
sort_key	No	String	Keyword by which the results to return are sorted. Keywords such as updated_at are supported. By default, the keyword created_at is used.
sort_dir	No	String	Result sorting order. The default value is desc. desc: descending order. asc: ascending order.
type	No	String	Specifies the project type to be queried.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. EPS is a global service. Therefore, when calling the IAM API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token.
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Minimum: 0 Maximum: 2048

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
enterprise_projects	Array of EpDetail objects	Enterprise project list.
total_count	Integer	Total number of enterprise projects.

**Table 4** EpDetail
Parameter	Type	Description
id	String	Enterprise project ID.
name	String	Enterprise project name.
description	String	Enterprise project description.
status	Integer	Enterprise project status. 1: enabled; 2: disabled.
created_at	String	UTC time when the enterprise project was created, for example, 2018-05-18T06:49:06Z.
updated_at	String	UTC time when the enterprise project was modified, for example, 2018-05-28T02:21:36Z.
type	String	Project type. prod: commercial project; poc: test project

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 6** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 8** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 402

**Table 9** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 10** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 12** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 13** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 14** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 405

**Table 15** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 16** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 406

**Table 17** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 18** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 407

**Table 19** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 20** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 408

**Table 21** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 22** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 409

**Table 23** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 24** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 25** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 26** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 501

**Table 27** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 28** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 502

**Table 29** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 30** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 503

**Table 31** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 32** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 504

**Table 33** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

**Table 34** RespErrorMessage
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

{
  "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
}

Status Codes

Status Code	Description
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