建立資料來源。
介面說明
方法
POST
URI
/openapi/ha3/instances/{instanceId}/data-sources
```。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
searchengine:CreateDataSource |
create |
*Instance
|
無 | 無 |
請求文法
POST /openapi/ha3/instances/{instanceId}/data-sources HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| instanceId |
string |
是 |
執行個體 ID。 |
ha-cn-pl32rf0**** |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| dryRun |
boolean |
否 |
是否 dryRun 建立(僅校驗資料來源是否合法)。取值:-true 是 -false 否。 |
true |
| body |
object |
否 |
請求結構。 |
{} |
| name |
string |
否 |
資料來源名稱。 |
ha-cn-pl32rf0****_test_api |
| type |
string |
否 |
資料來源類型:odps、oss、swift。 |
odps |
| domain |
string |
否 |
資料來源機房。 |
vpc_hz_domain_1 |
| config |
object |
否 |
設定資訊。 |
|
| endpoint |
string |
否 |
odps 資料來源的 endpoint 或者 oss 資料來源的 endpoint。 |
http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api |
| accessKey |
string |
否 |
odps 資料來源 ak。 |
L***p |
| accessSecret |
string |
否 |
odps 資料來源 as。 |
5**9a6 |
| project |
string |
否 |
odps 資料來源專案名稱。 |
kubenest |
| partition |
string |
否 |
odps 分區。 |
ds=20220713 |
| table |
string |
否 |
odps 表名稱。 |
item |
| namespace |
string |
否 |
命名空間。 |
aegis-ops |
| path |
string |
否 |
hdfs 檔案路徑。 |
test-hdfs-path |
| ossPath |
string |
否 |
oss 檔案路徑。 |
/opensearch/search |
| bucket |
string |
否 |
oss bucket |
opensearch |
| catalog |
string |
否 |
||
| database |
string |
否 |
||
| tag |
string |
否 |
||
| saroConfig |
object |
否 |
saro 資料來源設定。 |
|
| namespace |
string |
否 |
saro 資料來源的 namespace。 |
igraph-cn-x0r3e3abe02 |
| tableName |
string |
否 |
saro 資料表名稱。 |
index_hdfs |
| autoBuildIndex |
boolean |
否 |
自動重建索引。 |
true |
請求範例
POST /openapi/ha3/instances/ha3_instances_id/data-sources
{
"name": "data_source_name",
"type": "odps",
"config":{
"accessKey": "xxx",
"accessSecret": "xxxs",
"project":"xxxx",
"table":"xxx",
"partition":"xxxx"
},
"autoBuildIndex": true
}
```。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| requestId |
string |
請求 ID。 |
10D5E615-69F7-5F49-B850-00169ADE513C |
| result |
object |
返回結果。 |
{} |
返回範例
正確返回
{
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": []
}
錯誤返回
{
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": {
"success": false,
"data": "some error message"
}
}
詳情可參考回應結構。
樣本
正常返回樣本
JSON格式
{
"requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
"result": {}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。