全部产品
Search
文档中心

智能开放搜索 OpenSearch:GetDataSourceDeploy - 获取数据源部署信息

更新时间:May 13, 2024

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:GetDataSourceDeployRead
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-uax37kni501
deployNamestring

机房

vpc_hz_domain_1
dataSourceNamestring

数据源的名称

ha-cn-9lb34d9ee01_image_embedding

返回参数

名称类型描述示例值
object
requestIdstring

requestId

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

Deploy

storageobject

数据源信息

endpointstring

odps endpoint

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

AK

ak
accessSecretstring

AS

as
projectstring

odps 数据源项目名称

wireless_1688_personal_rec
partitionstring

ODPS Partition。例如:ds=20180102

ds=20220926
tablestring

saro、odps 数据源表名

behavior
namespacestring

saro 相关

lazada-campaign-flink
pathstring

hdfs 相关

/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/
ossPathstring

oss 数据源相关

oss://opensearch
bucketstring

oss bucket

antsys-miniapp-chongwen-static
autoBuildIndexboolean

是否开启自动全量

true
processorobject

进程参数

argsstring

进程启动参数

{}
resourcestring

资源信息

{}
extendobject

字段配置的扩展的内容 key: 向量字段(vector)、 需 embeding 字段(embeding)

saroobject

saro 数据源信息

pathstring

hdfs 数据源路径

dist-dmj-job/src/main/java
versionstring

版本号

0.6.0
hdfsobject

hdfs 信息

pathstring

hdfs 数据源路径

dist-dmj-job/src/main/java
odpsobject

odps 数据源信息

partitionsobject

数据源的分区信息

string

数据源的分区信息

ds=20220926
ossobject

oss 信息

pathstring

oss 数据源路径

oss://opensearch
swiftobject

增量 swift 信息

zkstring

zk

zk
topicstring

topic

topic

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-01OpenAPI 描述信息更新看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新