GetDataSourceDeploy - OpenSearch

データソースのデプロイメント情報を取得します。

操作説明

メソッド

GET

URI

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

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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	MaxCompute データソースのエンドポイント。	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	MaxCompute データソースの AccessKey ID。	L***p
accessSecret	string	MaxCompute データソースの AccessKey シークレット。	5**9a6
project	string	MaxCompute プロジェクトの名前。	wireless_1688_personal_rec
partition	string	MaxCompute データソースのパーティション。例: ds=20180102	ds=20220926
table	string	SARO または MaxCompute データソース内のテーブルの名前。	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 バケット。	test-oss-bucket
catalog	string
database	string
tag	string
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	フィールド設定の拡張コンテンツ。キーは、ベクターフィールドの場合は `vector`、埋め込みが必要なフィールドの場合は `embedding` になります。
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	MaxCompute データソースに関する情報。
partitions	object	データソースのパーティション情報。
	string	データソースのパーティション情報。	ds=20220926
oss	object	OSS 情報。
path	string	OSS データソースのパス。	oss://opensearch
swift	object	Swift からの増分データに関する情報。
zk	string	ZooKeeper サービス。	test-zk
topic	string	Topic です。	ha-cn-pl32rf0****_test_api

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。