Obtaining the Cloud Storage List

Function

Obtain the cloud storage list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/cae/volumes

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. See Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Definition Resource type. Options: OBS and SFS. Range obs sfs Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference. The value of X-Subject-Token in the response header is the token value.
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or is set to 0, resources in the default enterprise project are queried. NOTE: For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List. In the response, id under items indicates the environment ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1.
kind	String	API type. Fixed value: Volume.
items	Array of Volume objects	Cloud storage list.

**Table 5** Volume
Parameter	Type	Description
id	String	Cloud storage ID.
resource_info	Map<String,String>	Storage resource details.
resource_name	String	Cloud storage name.
resource_type	String	Definition Resource type. Options: OBS and SFS. Range obs sfs Default Value N/A
resource_sub_type	String	Definition Storage resource subtype. Range parallel_file_system object_bucket sfs3.0 Default Value N/A
access	String	User access key.
time	String	Creation time.

Example Requests

Obtain the cloud storage list.

GET https://{endpoint}/v1/{project_id}/cae/volumes

Example Responses

Status code: 200

{
  "api_version" : "v1",
  "kind" : "Volume",
  "items" : [ {
    "id" : "a061934d-52e3-4b36-aea7-6c51879f84c9",
    "resource_name" : "test",
    "resource_sub_type" : "parallel_file_system",
    "resource_info" : {
      "capacity" : "0.00MB",
      "obsType" : "STANDARD",
      "region" : "region"
    },
    "access" : "xxx",
    "time" : "2023-02-08T09:31:39.858115Z"
  }, {
    "id" : "bef119d0-c7d1-4b58-9794-8b74faf80a59",
    "resource_name" : "test-nacos",
    "resource_sub_type" : "object_bucket",
    "resource_info" : {
      "capacity" : "0.00MB",
      "obsType" : "STANDARD",
      "region" : "region"
    },
    "access" : "xxx",
    "time" : "2023-02-08T09:31:49.232412Z"
  }, {
    "id" : "ece8ebcd-3f1e-4175-98ea-369036acbfce",
    "resource_name" : "test-nginx",
    "resource_sub_type" : "parallel_file_system",
    "resource_info" : {
      "capacity" : "0.00MB",
      "obsType" : "STANDARD",
      "region" : "region"
    },
    "access" : "xxx",
    "time" : "2023-02-15T03:24:08.146911Z"
  } ]
}