GetDataSourceDeploy - 获取数据源部署信息 - 智能开放搜索 OpenSearch

获取数据源部署信息。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}

调试

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

调试

授权信息

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

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

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

请求语法

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-pl32rf0****
deployName	string	是	机房	vpc_hz_domain_1
dataSourceName	string	是	数据源的名称	ha-cn-pl32rf0****_test_api

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	返回结果。
storage	object	数据源信息
endpoint	string	odps 数据源的 endpoint	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	odps 数据源 ak	L***p
accessSecret	string	odps 数据源 ak secret	5**9a6
project	string	odps 数据源项目名称	wireless_1688_personal_rec
partition	string	odps 数据源分区。例如：ds=20180102	ds=20220926
table	string	saro、odps 数据源表名	behavior
namespace	string	saro 相关	lazada-campaign-flink
path	string	hdfs 相关	/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/
ossPath	string	oss 数据源相关	/opensearch/test.json
bucket	string	oss bucket	test-oss-bucket
autoBuildIndex	boolean	是否开启自动全量	true
processor	object	进程参数
args	string	进程启动参数	{ "processInfos": [], "groupId": "opensearch", "containerConfigs": [], "priority": { "minor_priority": 0, "major_priority": 64 } }
resource	string	资源信息	[{ "_bs_role": "processor.*.inc", "priority": { "major_priority": 32, "minor_priority": 0 }, "slotResources": [{ "slotResources": [{ "amount": 200, "name": "cpu" }, { "amount": 8192, "name": "mem" }, { "amount": 0, "name": "T4" }, { "amount": 10, "type": "SCALAR", "name": "disk_ratio_9999" }, { "amount": 20480, "type": "SCALAR", "name": "disk_size_9999" }] }] }]
extend	object	字段配置的扩展的内容 key: 向量字段(vector)、需 embeding 字段(embeding)
saro	object	saro 数据源信息
path	string	hdfs 数据源路径	dist-dmj-job/src/main/java
version	string	版本号	0.6.0
hdfs	object	hdfs 信息
path	string	hdfs 数据源路径	dist-dmj-job/src/main/java
odps	object	odps 数据源信息
partitions	object	数据源的分区信息
	string	数据源的分区信息	ds=20220926
oss	object	oss 信息
path	string	oss 数据源路径	oss://opensearch
swift	object	增量 swift 信息
zk	string	zk	test-zk
topic	string	topic	ha-cn-pl32rf0****_test_api

示例

正常返回示例

JSON格式

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "storage": {
      "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
      "accessKey": "L***p",
      "accessSecret": "5**9a6",
      "project": "wireless_1688_personal_rec",
      "partition": "ds=20220926",
      "table": "behavior",
      "namespace": "lazada-campaign-flink",
      "path": "/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/",
      "ossPath": "/opensearch/test.json",
      "bucket": "test-oss-bucket",
      "catalog": "",
      "database": "",
      "tag": ""
    },
    "autoBuildIndex": true,
    "processor": {
      "args": "{\n\t\"processInfos\": [],\n\t\"groupId\": \"opensearch\",\n\t\"containerConfigs\": [],\n\t\"priority\": {\n\t\t\"minor_priority\": 0,\n\t\t\"major_priority\": 64\n\t}\n}",
      "resource": "[{\n\t\"_bs_role\": \"processor.*.inc\",\n\t\"priority\": {\n\t\t\"major_priority\": 32,\n\t\t\"minor_priority\": 0\n\t},\n\t\"slotResources\": [{\n\t\t\"slotResources\": [{\n\t\t\t\"amount\": 200,\n\t\t\t\"name\": \"cpu\"\n\t\t}, {\n\t\t\t\"amount\": 8192,\n\t\t\t\"name\": \"mem\"\n\t\t}, {\n\t\t\t\"amount\": 0,\n\t\t\t\"name\": \"T4\"\n\t\t}, {\n\t\t\t\"amount\": 10,\n\t\t\t\"type\": \"SCALAR\",\n\t\t\t\"name\": \"disk_ratio_9999\"\n\t\t}, {\n\t\t\t\"amount\": 20480,\n\t\t\t\"type\": \"SCALAR\",\n\t\t\t\"name\": \"disk_size_9999\"\n\t\t}]\n\t}]\n}]"
    },
    "extend": {
      "saro": {
        "path": "dist-dmj-job/src/main/java",
        "version": "0.6.0"
      },
      "hdfs": {
        "path": "dist-dmj-job/src/main/java"
      },
      "odps": {
        "partitions": {
          "key": "ds=20220926"
        }
      },
      "oss": {
        "path": "oss://opensearch"
      }
    },
    "swift": {
      "zk": "test-zk",
      "topic": "ha-cn-pl32rf0****_test_api"
    }
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-07-19	OpenAPI 返回结构发生变更	查看变更详情
2023-03-01	OpenAPI 描述信息更新	查看变更详情