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

Querying an Enterprise Project

Function

This API is used to query details about an enterprise project.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/enterprise-projects/{enterprise_project_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

Yes

String

Enterprise project ID. You can obtain the value by calling the API for listing enterprise projects.

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

enterprise_project

EpDetail object

Enterprise project.

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: 410

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: 500

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: 501

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: 502

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: 503

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.

Status code: 504

Table 35 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Error request information.

Table 36 RespErrorMessage

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "enterprise_project" : {
    "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
    "name" : "enterprise_project1",
    "description" : "Specifies the description.",
    "type" : "prod",
    "status" : 1,
    "created_at" : "2016-03-28T00:00:00Z",
    "updated_at" : "2016-03-28T00:00:00Z"
  }
}

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

410

Gone

500

Internal Server Error

501

Not Implemented

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

Error Codes

See Error Codes.