tencent cloud

文档反馈

CreateDedicatedClusterOrder

最后更新时间:2024-11-27 15:19:34

1. API Description

Domain name for API request: cdc.intl.tencentcloudapi.com.

This API is used to create a CDC order.

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: CreateDedicatedClusterOrder.
Version Yes String Common Params. The value used for this API: 2020-12-14.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DedicatedClusterId Yes String CDC id
DedicatedClusterTypes.N No Array of DedicatedClusterTypeInfo Array of order-related CDC types
CosInfo No CosInfo Order-related COS storage information
CbsInfo No CbsInfo Order-related CBS storage information
PurchaseSource No String Purchase source, cloudApi by default
DedicatedClusterOrderId No String DedicatedClusterOrderId needs to be submitted when API is invoked to submit an order.

3. Output Parameters

Parameter Name Type Description
DedicatedClusterOrderId String CDC order id
Note: The returned value of this field may be null, indicating that no valid value is 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 CDC order.

This example shows you how to create a CDC order.

Input Example

https://cdc.intl.tencentcloudapi.com/?Action=CreateDedicatedClusterOrder
&DedicatedClusterId=cluster-gbo27yc4
&DedicatedClusterTypes.0.Id=cluster-gbo27yc4
&DedicatedClusterTypes.0.Count=1
&CosInfo.Size=1
&CosInfo.Type=COS
&CbsInfo.Size=1
&CbsInfo.Type=SSD
&<Common request parameters>

Output Example

{
    "Response": {
        "DedicatedClusterOrderId": "ord-0yq4a8ia",
        "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
    }
}

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
InvalidParameterValue The parameter value is invalid.
InvalidParameterValue.InvalidValueDedicatedClusterCosSize The COS size of CDC is incorrect.
InvalidParameterValue.InvalidValueDedicatedClusterDataStepSize The CBS size is incorrect. It must be an integral multiple of 40.
ResourceNotFound.InvalidDedicatedClusterId The resource is not found.
ResourceNotFound.InvalidDedicatedClusterOrderId Please check whether the resource ID exists.
ResourceNotFound.InvalidDedicatedClusterTypeId The resource is not found.
UnsupportedOperation.NonCustomerAppIdNotSupport Non-CUSTOMER type app id is not supported.