Help Center/ Data Lake Insight/ API Reference/ APIs Related to Elastic Resource Pools/ Modifying Elastic Resource Pool Information
Updated on 2024-08-19 GMT+08:00

Modifying Elastic Resource Pool Information

Function

This API is used to modify elastic resource pool information.

URI

  • URI format

    PUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    elastic_resource_pool_name

    Yes

    String

    Elastic resource pool name.

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

description

No

String

Description. The value can contain a maximum of 256 characters.

max_cu

No

Integer

Maximum CUs allowed for an elastic resource pool.

min_cu

No

Integer

Maximum CUs allowed for an elastic resource pool.

Response

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

System prompt. If execution succeeds, the message may be left blank.

Example Request

Modify the description, maximum CUs, and minimum CUs of the elastic resource pool. After the modification, the minimum CUs is 78 and the maximum CUs is 990.

{
  "description" : "test_update",
  "min_cu" : 78,
  "max_cu" : 990
}

Example Response

{
  "is_success" : true,
  "message" : ""
}

Status Codes

Status Code

Description

200

OK

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.