使用GetDataSourceDeploy API擷取資料來源部署資訊-智能OpenSearch OpenSearch-阿里雲 - 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

請求參數

名稱

類型

必填

描述

樣本值

當前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
catalog	string	DLF 資料目錄 ID。	clg-paimon-21cc136237a6457f8618f5f82d116d7e
database	string	DLF 資料庫名稱。	dlf_test
tag	string	DLF 資料來源標籤。	test_tag
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": "clg-paimon-21cc136237a6457f8618f5f82d116d7e",
      "database": "dlf_test",
      "tag": "test_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"
    }
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。