- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
DescribeVolumes
Last updated: 2024-07-26 15:26:19
1. API Description
Domain name for API request: omics.tencentcloudapi.com.
This API is used to query the volume list.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeVolumes. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| EnvironmentId | Yes | String | Environment ID |
| Limit | No | Integer | Quantity of returns. It is 20 by default, and the maximum value is 100. |
| Offset | No | Integer | Offset, defaults to 0 |
| Filters.N | No | Array of Filter | Filter, supports filtering fields: - Name: Name - IsDefault: Whether it is the default. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Volumes | Array of Volume | Volume Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Number of qualified items Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the Volume List
This example shows you how to query the volume list.
Input Example
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVolumes
<Common request parameters>
{
"EnvironmentId": "menv-ry46eloh"
}
Output Example
{
"Response": {
"RequestId": "f5020059-1511-4f45-ab7e-5188a78bda4b",
"TotalCount": 1,
"Volumes": [
{
"BandwidthLimit": 380,
"Capacity": 32768,
"DefaultMountPath": "/vol-8w7rfq4b",
"Description": "",
"EnvironmentId": "menv-ry46eloh",
"IsDefault": true,
"Name": "Default volume (menv-ry46eloh)",
"Spec": "HP",
"Status": "AVAILABLE",
"Type": "SHARED",
"Usage": 973150879744,
"VolumeId": "vol-8w7rfq4b"
}
]
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded | Exceeded the quota limit. |
| OperationDenied | Operation rejected. |
| ResourceNotFound | The resource does not exist. |
Yes
No
Was this page helpful?