Updated on 2022-12-08 GMT+08:00

Querying Details About a Specified Enterprise Project

Function

This API is used to query details about a specified enterprise project.

URI

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

For detailed about the parameters, see Table 1.
Table 1 Parameter in the URI

Name

Mandatory

Type

Description

enterprise_project_id

Yes

String

Specifies the enterprise project ID.

You can obtain the ID by using API Querying the Enterprise Project List.

Request

  • Example request
    GET https://{EPS endpoint}/v1.0/enterprise-projects/5aa119a8-d25b-45a7-8d1b-88e127885635

Response

  • Parameter description
    Table 2 Parameter in the response

    Name

    Type

    Description

    enterprise_project

    Dict<enterprise_project>

    Specifies the enterprise project.

    For details, see Table 3.

  • enterprise_project field data structure
    Table 3 enterprise_project field data structure description

    Name

    Type

    Description

    id

    String

    Specifies the enterprise project ID.

    name

    String

    Specifies the enterprise project name.

    description

    String

    Provides supplementary information about the enterprise project.

    status

    Integer

    1 indicates Enabled. 2 indicates Disabled.

    created_at

    String

    Specifies the time (UTC) when the enterprise project was created.

    Example: 2018-05-18T06:49:06Z

    updated_at

    String

    Specifies the time (UTC) when the enterprise project was modified.

    Example: 2018-05-18T06:49:06Z

  • Example response
    {
        "enterprise_project": {
            "id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
            "name": "enterprise_project1",
            "description": "description",
            
            "status": 1,
            "created_at": "2016-03-28T00:00:00Z",
            "updated_at": "2016-03-28T00:00:00Z"
        }
    }

Status Codes

For details, see Status Code.

Error Codes

For details, see Error Codes.