GetDataSourceDeploy - OpenSearch - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-uax37kni501
dataSourceName	string	Yes	The name of the data source.	ha-cn-9lb34d9ee01_image_embedding

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	requestId	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	The result.
storage	object	The information about the data source.
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.	ak
accessSecret	string	The AccessKey secret of the MaxCompute data source.	as
partition	string	The partition in the MaxCompute table. Example: ds=20180102.	ds=20220926
ossPath	string	The Object Storage Service (OSS) path.	oss://opensearch
bucket	string	The name of the OSS bucket.	antsys-miniapp-chongwen-static
processor	object	The parameters of the process.
args	string	The startup parameters of the process.	{}
resource	string	The resource information.	{}
swift	object	The information about the incremental data source Swift.
zk	string	zk	zk
topic	string	The topic.	topic

Examples

Sample success responses

JSONformat

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "storage": {
      "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
      "accessKey": "ak",
      "accessSecret": "as",
      "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": "oss://opensearch",
      "bucket": "antsys-miniapp-chongwen-static"
    },
    "autoBuildIndex": true,
    "processor": {
      "args": "{}",
      "resource": "{}"
    },
    "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": "zk",
      "topic": "topic"
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-19	The response structure of the API has changed	View Change Details
2023-03-01	API Description Update	View Change Details