Help Center/ Enterprise Management/ API Reference/ Enterprise Project Management APIs/ Enterprise Project Management/ Modifying an Enterprise Project

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

View PDF

Modifying an Enterprise Project

Function

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

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	Yes	String	Enterprise project ID, which cannot be 0. 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.
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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	The value can contain a maximum of 64 characters consisting of letters, digits, underscores (_), and hyphens (-). The name cannot be default and must be unique in the tenant account.
description	No	String	A description can contain a maximum of 512 characters. Maximum: 512
type	No	String	Enterprise project type. Default: prod

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
enterprise_project	EpDetail object	Enterprise project.

**Table 5** 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 6** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Error request information.

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

Status code: 401

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

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

Status code: 402

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

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

Status code: 403

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

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

Status code: 404

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

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

Status code: 405

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

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

Status code: 406

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

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

Status code: 407

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

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

Status code: 408

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

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

Status code: 409

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

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

Status code: 410

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

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

Status code: 500

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

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

Status code: 501

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

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

Status code: 502

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

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

Status code: 503

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

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

Status code: 504

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

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

Example Requests

Modifying an Enterprise Project

PUT https://{Endpoint}/v1.0/enterprise-projects/{enterprise_project_id}

{
  "name" : "enterprise_project1",
  "description" : "Specifies the description."
}

Example Responses

Status code: 200

{
  "enterprise_project" : {
    "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
    "name" : "enterprise_project1",
    "description" : "Specifies the description.",
    "status" : 1,
    "type" : "prod",
    "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