Creates data sources.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| searchengine:CreateDataSource | create |
|
| none |
Request syntax
POST /openapi/ha3/instances/{instanceId}/data-sources HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| instanceId | string | Yes | The instance ID. | ha-cn-7e22rgfyb01 |
| dryRun | boolean | No | 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 |
| body | object | No | The request body. | |
| name | string | No | The name of the data source. | ha-cn-pl32rf0****_test_api |
| type | string | No | The type of the data source. Valid values: odps, oss, and swift. | odps |
| domain | string | No | The data center in which the data source is deployed. | vpc_hz_domain_1 |
| config | object | No | The configuration information. | |
| endpoint | string | No | The endpoint of the MaxCompute or Object Storage Service (OSS) data source. | http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api |
| accessKey | string | No | The AccessKey ID of the MaxCompute data source. | L***p |
| accessSecret | string | No | The AccessKey secret of the MaxCompute data source. | 5**9a6 |
| project | string | No | The name of the MaxCompute project that is used as the data source. | kubenest |
| partition | string | No | The partition in the MaxCompute table. | ds=20220713 |
| table | string | No | The name of the MaxCompute table that is used as the data source. | item |
| namespace | string | No | The namespace. | aegis-ops |
| path | string | No | The file path in the Apsara File Storage for HDFS file system. | test-hdfs-path |
| ossPath | string | No | The path of the OSS object. | /opensearch/search |
| bucket | string | No | The name of the OSS bucket. | opensearch |
| saroConfig | object | No | The configurations of the SARO data source. | |
| namespace | string | No | The namespace of the SARO data source. | igraph-cn-x0r3e3abe02 |
| tableName | string | No | The name of the SARO table. | index_hdfs |
| autoBuildIndex | boolean | No | Specifies whether to automatically rebuild the index. | true |
Response parameters
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 time | Summary of changes | Operation |
|---|---|---|
| 2023-07-19 | The response structure of the API has changed | View Change Details |
| 2022-01-12 | Add Operation | View Change Details |