Updating the Name of a DSS Storage Pool

Function

This API is used to update the name of a DSS storage pool.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v1/{project_id}/pools/{dss_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID. For details, see Obtaining a Project ID.
dss_id	Yes	String	The DSS storage pool ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
pool	No	DssUpdatePoolDetail object

**Table 4** DssUpdatePoolDetail
Parameter	Mandatory	Type	Description
name	No	String	The DSS storage name.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
name	String	The storage pool name.
id	String	The storage pool ID.
project_id	String	The ID of the belonging project.
capacity	Integer	The requested storage pool capacity, in GB.
type	String	The storage pool type. SAS: high I/O storage pool SSD: ultra-high I/O storage pool
status	String	The storage pool status. For details, see DSS Storage Pool Status.
availability_zone	String	The AZ where the storage pool resides.
created_at	String	The time when the storage pool was created.
total_capacity_gb	Integer	The total capacity.
used_capacity_gb	Integer	The used capacity.
provisioned_capacity_gb	Integer	The allocated capacity.
max_over_subscription_ratio	Float	The overcommitment ratio.

Example Requests

PUT https://{endpoint}/v1/{project_id}/pools/{dss_id}

{
  "pool" : {
    "name" : "dss-test"
  }
}

Example Responses

Status code: 200

The DSS details.

{
  "name" : "dedicatedStorage01",
  "id" : "c950ee97-587c-4f24-8a74-3367e3da570f",
  "project_id" : "63d910f2705a487ebe4e1c274748d9e1",
  "capacity" : 100,
  "type" : "SSD",
  "availability_zone" : "AZ1",
  "status" : "available",
  "created_at" : "2022-12-18T15:57:56.299000",
  "total_capacity_gb" : 1000,
  "used_capacity_gb" : 300,
  "provisioned_capacity_gb" : 700,
  "max_over_subscription_ratio" : "1.0"
}