tencent cloud

Cloud Infinite

DokumentasiCloud InfiniteAPI DocumentationIntelligent Search MetaInsightBasic SearchAsynchronous Export of Query ResultsCreating an Asynchronous Export Task

Creating an Asynchronous Export Task

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-08 16:18:35
Diterjemahkan & Diperiksa oleh AI

Feature Description

This API supports creating asynchronous search export tasks, making it suitable for large-scale data search processing. When search results are too large to be returned synchronously, you can submit a task through this API. After processing is complete, the results are asynchronously stored in the COS Bucket path that you specify.

Authorization Description

When using a sub-account, add the ci:CreateDatasetExport permission to the action of the authorization policy. For all operation APIs supported by Cloud Infinite, see CI action.

Use Limits

Before using this API, confirm the relevant restrictions. For details, see Usage Limits.

Service Activation

When you use this feature for the first time, Cloud Infinite is activated for you by default, and the Bucket is automatically bound. You can use the feature directly without role authorization.
Note:
After Cloud Infinite is bound, if you manually unbind Cloud Infinite from the bucket, you will no longer be able to use this feature.

Request

Request sample

POST /datasetquery/export HTTP/1.1
Host: <AppId>.ci.ap-jakarta.myqcloud.com
Authorization: Auth String
Content-Length: 100
Content-Type: application/json
Accept: application/json
Note:
Authorization: Auth String (For details, see Request Signature).

Request header

This API only uses common request headers. For details, see Common Request Headers.

Request body


{
	"Name": "fortest",
	"DatasetName": "test",
	"ExportJobType": 1,
	"Query": {
		"Operation": "and",
		"SubQueries": [{
				"Field": "ContentType",
				"Value": "image/jpeg",
				"Operation": "eq"
			},
			{
				"Field": "Size",
				"Value": "1000",
				"Operation": "gt"
			}
		]
	},
	"Output": {
		"Bucket": "test-1250000000",
		"Object": "prefix001",
		"Region": "ap-jakarta"
	}
}

Request Parameters

The specific parameters are as follows:
Parameter Name
Description
Type
Required
Name
Name of the new task. Supports Chinese, English, digits, hyphens (-), and underscores (_), with a maximum length of 128 characters
String
Yes
DatasetName
Dataset name, unique within the same account
String
Yes
ExportJobType
Task type: 1. Data export; 2. Data preheating, with a default value of 1
Integer
No
Query
Simple query parameter conditions that can be nested
Container
No
Output
Storage location of task results
Container
No. Required when ExportJobType is 1.
GfsPreHeatConfig
Preheating configuration
Container
No. Required when ExportJobType is 2.
For the specific data description of the Container type Query, see the description of the Query field in the Scalar Search API.
The specific data description of the Container type Output is as follows:
Parameter Name
Parent Node
Description
Type
Required
Region
Request.Output
Region of the bucket for storing results
String
Yes
Bucket
Request.Output
Bucket for storing results
String
Yes
Object
Request.Output
Filename of the output result
String
Yes
The specific data description of the Container type GfsPreHeatConfig is as follows:
Parameter Name
Parent Node
Description
Type
Required
ClusterId
Request.GfsPreHeatConfig
Preheat cluster instance ID
String
Yes
Priority
Request.GfsPreHeatConfig
Task priority. The value ranges from 1 to 9999. A larger value indicates a higher priority. The default value is 1
Integer
No

Response

Response Headers

This API only returns common response headers. For details, see Common Response Headers.

Response Body


{
	"Job": {
		"JobId": "xxxxxx",
		"Name": "fortest",
		"ExportJobType": 1,
		"Query": {
			"Operation": "and",
			"SubQueries": [{
					"Field": "ContentType",
					"Value": "image/jpeg",
					"Operation": "eq"
				},
				{
					"Field": "Size",
					"Value": "1000",
					"Operation": "gt"
				}
			]
		},
		"Output": {
			"Bucket": "test-1250000000",
			"Object": "prefix001",
			"Region": "ap-jakarta"
		},
		"CreateTime": "2025-04-09T19:38:08.454310276+08:00",
		"StartTime": "1970-01-01T00:00:00+08:00",
		"EndTime": "1970-01-01T00:00:00+08:00",
		"State": "todo",
		"GfsPreHeatConfig": {
			"ClusterId": "",
			"Priority": 1
		},
		"Progress": 0
	},
	"RequestId": "NjdmNjVjMjBfNzM0NjZjMT**********"
}
The specific data content of the response body is as follows:
Parameter Name
Type
Description
RequestId
String
Request ID
Job
Container
Information about the created task
Job node content:
Parameter Name
Type
Description
Name
String
Task Name
JobId
String
Job ID, required for queries
ExportJobType
Integer
Task type: 1. Data export; 2. Data preheating
State
String
Task status, including todo (pending) / running (in progress) / failed / done
Query
Container
Simple query parameter conditions, same as the value passed in the request
Output
Container
Storage location of task results, same as the value passed in the request
GfsPreHeatConfig
Container
Preheating configuration, same as the value passed in the request
StartTime
String
Task start time
EndTime
String
Task end time
CreateTime
String
Task creation time
Progress
Integer
Percentage of task completion progress
GfsPreHeatConfig node content:
Parameter Name
Type
Description
ClusterId
String
Preheat cluster instance ID
Priority
Integer
Task priority. A higher value indicates a higher priority. The value ranges from 1 to 9999, and the default value is 1

Topik sebelumnya: Scalar SearchTopik selanjutnya: Querying Asynchronous Export Tasks

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan

Search
    Enter keywords to search documentation