Updated on 2024-04-16 GMT+08:00

Modifying an Enterprise Project

Function

This API is used to modify an enterprise project. Only the enterprise project name and description can be modified.

URI

PUT /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. The enterprise project whose ID is 0 cannot be modified.

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

Request

  • Parameter description
    Table 2 Parameters in the request

    Name

    Mandatory

    Type

    Description

    name

    Yes

    String

    A name can contain 1 to 255 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. The name must be unique in the domain and cannot include any form of the word "default".

    description

    No

    String

    A description can contain a maximum of 512 characters.

    type

    No

    String

    Specifies the enterprise project type.

  • Example request
    PUT https://{EPS endpoint}/v1.0/enterprise-projects/{enterprise_project_id}
    {
       "name":"enterprise_project1",
       "description": "description"
    }

Response

  • Parameter description
    Table 3 Parameter in the response

    Name

    Type

    Description

    enterprise_project

    Dict<enterprise_project>

    Specifies the enterprise project.

    For details, see Table 4.

  • enterprise_project data structure
    Table 4 enterprise_project 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.