GetDataSourceDeploy - OpenSearch - Alibaba Cloud Documentation Center

Retrieves the deployment information for a data source.

Operation description

Method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:GetDataSourceDeploy

get

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
deployName	string	Yes	The data center.	vpc_hz_domain_1
dataSourceName	string	Yes	The name of the data source.	ha-cn-pl32rf0****_test_api

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	The returned result.
storage	object	The data source information.
endpoint	string	The endpoint of the MaxCompute data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	The AccessKey ID of the MaxCompute data source.	L***p
accessSecret	string	The AccessKey secret of the MaxCompute data source.	5**9a6
project	string	The name of the MaxCompute project.	wireless_1688_personal_rec
partition	string	The partition of the MaxCompute data source. For example: ds=20180102	ds=20220926
table	string	The name of the table in the SARO or MaxCompute data source.	behavior
namespace	string	Information related to SARO.	lazada-campaign-flink
path	string	Information related to HDFS.	/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/
ossPath	string	Information related to the OSS data source.	/opensearch/test.json
bucket	string	The OSS bucket.	test-oss-bucket
catalog	string
database	string
tag	string
autoBuildIndex	boolean	Indicates whether automatic full indexing is enabled.	true
processor	object	The processor parameters.
args	string	The startup parameters for the process.	{ "processInfos": [], "groupId": "opensearch", "containerConfigs": [], "priority": { "minor_priority": 0, "major_priority": 64 } }
resource	string	The resource information.	[{ "_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	The extended content of the field configuration. The key can be `vector` for vector fields or `embedding` for fields that require embedding.
saro	object	The information about the SARO data source.
path	string	The path of the HDFS data source.	dist-dmj-job/src/main/java
version	string	The version number.	0.6.0
hdfs	object	The HDFS information.
path	string	The path of the HDFS data source.	dist-dmj-job/src/main/java
odps	object	The information about the MaxCompute data source.
partitions	object	The partition information of the data source.
	string	The partition information of the data source.	ds=20220926
oss	object	The OSS information.
path	string	The path of the OSS data source.	oss://opensearch
swift	object	The information about incremental data from Swift.
zk	string	The ZooKeeper service.	test-zk
topic	string	The topic.	ha-cn-pl32rf0****_test_api

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.