Updated on 2025-07-25 GMT+08:00

Modifying the IDC Description

Function

This API is used to modify the IDC description.

Calling Method

For details, see Calling APIs.

URI

PUT https://www.example.com/v1/{project_id}/idcs

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID.

Constraints

N/A

Range

The project ID of the account

Default Value

N/A

Request Parameters

Table 2 Request header parameter

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

Range

N/A

Default Value

N/A

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

[Array element]

Yes

Array of - objects

Definition

Batch update of IDC sets.

Constraints

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

-

String

-

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error message.

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 6 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error message.

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 7 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error message.

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 8 Response body parameters

Parameter

Type

Description

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Example Request

Request for modifying the IDC description

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

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

Example Response

Status code: 200

The request has been processed.

update idc success

Status Codes

Status Code

Description

200

The request has succeeded.

400

Invalid request parameter.

401

Request error. User not authorized.

429

Request error due to too frequent requests.

500

Internal server error.

Error Codes

For details, see Error Codes.