CreateDataSource - 创建数据源 - 智能开放搜索 OpenSearch

创建数据源。

接口说明

方法

POST

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:CreateDataSource	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

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
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": {}
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-07-19	OpenAPI 返回结构发生变更	查看变更详情
2022-01-12	新增 OpenAPI	查看变更详情