Updated on 2026-06-08 GMT+08:00

Modifying the IDC Description

Function

This API is used to modify the IDC description.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

clouddc:idc:update

Write

-

-

-

-

URI

PUT /v1/{project_id}/idcs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID.

Constraints:

N/A

Value range:

Project IDs of the account

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of IDcRequest objects

Definition

Updating IDC information.

Constraints

N/A

Table 4 IDcRequest

Parameter

Mandatory

Type

Description

id

Yes

String

Definition

Equipment room ID.

Constraints

N/A

Range

Equipment room ID range.

Default Value

N/A

description

No

String

Definition

Equipment room description.

Constraints

N/A

Range

Maximum length: 512 characters

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error description.

Constraints

N/A

Range

N/A

Default Value

N/A

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error description.

Constraints

N/A

Range

N/A

Default Value

N/A

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Status code: 429

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error description.

Constraints

N/A

Range

N/A

Default Value

N/A

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error description.

Constraints

N/A

Range

N/A

Default Value

N/A

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Example Requests

Modifying IDC description

PUT https://{endpoint}/v1/{project_id}/idcs

[ {
  "description" : "test",
  "id" : "019674ed-07c1-7496-b6a8-96989d73efa9"
} ]

Example Responses

Status code: 200

The request has succeeded.

update idc success

Status Codes

Status Code

Description

200

The request has succeeded.

400

Invalid request parameter.

401

Request error due to user authorization not granted.

429

Request error due to too frequent requests.

500

Internal server error.

Error Codes

See Error Codes.