All Products
Search
Document Center

OpenSearch:CreateDataSource

Last Updated:Jul 19, 2024

Creates data sources.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /openapi/ha3/instances/{instanceId}/data-sources

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-7e22rgfyb01
dryRunbooleanNo

Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false.

true
bodyobjectNo

The request body.

namestringNo

The name of the data source.

ha-cn-pl32rf0****_test_api
typestringNo

The type of the data source. Valid values: odps, oss, and swift.

odps
domainstringNo

The data center in which the data source is deployed.

vpc_hz_domain_1
configobjectNo

The configuration information.

endpointstringNo

The endpoint of the MaxCompute or Object Storage Service (OSS) data source.

http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKeystringNo

The AccessKey ID of the MaxCompute data source.

L***p
accessSecretstringNo

The AccessKey secret of the MaxCompute data source.

5**9a6
projectstringNo

The name of the MaxCompute project that is used as the data source.

kubenest
partitionstringNo

The partition in the MaxCompute table.

ds=20220713
tablestringNo

The name of the MaxCompute table that is used as the data source.

item
namespacestringNo

The namespace.

aegis-ops
pathstringNo

The file path in the Apsara File Storage for HDFS file system.

test-hdfs-path
ossPathstringNo

The path of the OSS object.

/opensearch/search
bucketstringNo

The name of the OSS bucket.

opensearch
saroConfigobjectNo

The configurations of the SARO data source.

namespacestringNo

The namespace of the SARO data source.

igraph-cn-x0r3e3abe02
tableNamestringNo

The name of the SARO table.

index_hdfs
autoBuildIndexbooleanNo

Specifies whether to automatically rebuild the index.

true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

The ID of the request.

10D5E615-69F7-5F49-B850-00169ADE513C
resultobject

The returned results.

{}

Examples

Sample success responses

JSONformat

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-19The response structure of the API has changedView Change Details
2022-01-12Add OperationView Change Details