产品动态
产品公告
Domain name for API request: cfs.intl.tencentcloudapi.com.
This API is used to create a data flow.
A maximum of 20 requests can be initiated per second for this API.
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: CreateDataFlow. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| FileSystemId | Yes | String | File system ID, which can be obtained by querying the file system through the DescribeCfsFileSystems api. |
| SourceStorageType | Yes | String | Source data type; includes S3_COS, S3_L5. |
| SourceStorageAddress | Yes | String | Source storage address. |
| SourcePath | Yes | String | Source path. |
| TargetPath | Yes | String | Target path in the file system. |
| SecretId | Yes | String | Key ID. |
| SecretKey | Yes | String | key. |
| DataFlowName | No | String | Data flow name, supports no more than 64 characters in length, supports chinese, numbers, _, and -. |
| AutoRefresh | No | Integer | 0: disable auto-update 1: enable auto-update. |
| UserKafkaTopic | No | String | Topic Parameter used by KafkaConsumer during consumption |
| ServerAddr | No | String | Service address example value: kafkaconsumer-ap-beijing.cls.tencentyun.com:9095. |
| UserName | No | String | Kafka consuming user name. example value: name. |
| Password | No | String | Kafka consuming user password. default ${SecretId}#${SecretKey}. |
| Parameter Name | Type | Description |
|---|---|---|
| DataFlowId | String | Data flow manage ID. |
| 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. |
POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataFlow
<Common request parameters>
{
"FileSystemId": "cfs-44d53b63e",
"SourceStorageType": "S3_COS",
"SourceStorageAddress": "https://aileen-data-flow-1251000004.cos.ap-guangzhou.myqcloud.com",
"SourcePath": "test3",
"TargetPath": "/cfs/test11",
"SecretId": "AKIDbzzYj65vue75sC1yg8P4cyBHBpLk",
"SecretKey": "onE8m9NN82ik6h3FCvXt2uc3Sjp",
"DataFlowName": "abctest"
}
{
"Response": {
"DataFlowId": "cfs-dataflow-4f827203",
"RequestId": "c5369436-a47c-4504-9cfa-f1f40c2c969f"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InvalidDataFlowName | Invalid data flow name. |
| InvalidParameterValue.InvalidDataFlowSourceInfo | Parameter value error: invalid data flow source information. check the key and path. |
| InvalidParameterValue.InvalidDataFlowSourceStorageType | Parameter value error: data flow source storage type invalid. |
| InvalidParameterValue.InvalidDataFlowTargetPath | Parameter value error: data flow target path invalid. |
| InvalidParameterValue.InvalidFileSystemId | FileSystemId is invalid. |
| InvalidParameterValue.InvalidLifecycleDataTaskType | Parameter value error: lifecycle task type invalid. |
| ResourceInsufficient.DataFlowLimitExceeded | Insufficient resources: the number of data flows exceeds the limit. |
| ResourceNotFound.FileSystemNotFound | The file system does not exist. |
文档反馈