All Products
Search
Document Center

OpenSearch:GetDataSourceDeploy

Last Updated:Oct 16, 2024

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
searchengine:GetDataSourceDeployget
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-uax37kni501
dataSourceNamestringYes

The name of the data source.

ha-cn-9lb34d9ee01_image_embedding

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

requestId

2AE63638-5420-56DC-BF59-37D8174039A0
resultobject

The result.

storageobject

The information about the data source.

endpointstring

The endpoint of the MaxCompute data source.

http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKeystring

The AccessKey ID of the MaxCompute data source.

ak
accessSecretstring

The AccessKey secret of the MaxCompute data source.

as
partitionstring

The partition in the MaxCompute table. Example: ds=20180102.

ds=20220926
ossPathstring

The Object Storage Service (OSS) path.

oss://opensearch
bucketstring

The name of the OSS bucket.

antsys-miniapp-chongwen-static
processorobject

The parameters of the process.

argsstring

The startup parameters of the process.

{}
resourcestring

The resource information.

{}
swiftobject

The information about the incremental data source Swift.

zkstring

zk

zk
topicstring

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 timeSummary of changesOperation
2023-07-19The response structure of the API has changedView Change Details
2023-03-01API Description UpdateView Change Details