tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateVolume

Last updated: 2024-07-26 15:26:29

1. API Description

Domain name for API request: omics.tencentcloudapi.com.

This API is used to create a volume.

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: CreateVolume.
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
Name Yes String Name
Type Yes String Volume type. Valid values:
* SHARED: Multi-point mount shared storage
Spec Yes String Volume specifications. Valid values:

- SD: standard
- HP: high-performance
- TB: standard Turbo
- TP: high-performance Turbo
Description No String Description
Capacity No Integer Volume size (GB), which is required to be specified for the Turbo series.

3. Output Parameters

Parameter Name Type Description
VolumeId String Volume ID
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 Creating a Volume

This example shows you how to create a volume.

Input Example

POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVolume
<Common request parameters>

{
    "EnvironmentId": "menv-ry46eloh",
    "Name": "Test volume",
    "Type": "SHARED",
    "Spec": "HP",
    "Capacity": 0
}

Output Example

{
    "Response": {
        "RequestId": "d79c957c-adca-4e29-81ba-1add68284e09",
        "VolumeId": "vol-mpcb5xnl"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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.
OperationDenied Operation rejected.
ResourceInUse Resources are occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource not available.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy