全部产品
Search
文档中心

智能开放搜索 OpenSearch:ModifyDataSourceDeploy - 修改数据源部署信息

更新时间:Oct 16, 2024

修改数据源部署信息。

接口说明

方法

PUT

URI

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

调试

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

授权信息

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

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

请求语法

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

请求参数

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

实例 ID

ha-cn-pl32rf0****
deployNamestring

机房

vpc_hz_domain_1
dataSourceNamestring

数据源名称

ha-cn-pl32rf0****_test_api
generationIdlong

索引全量版本

1708674867
dryRunboolean

是否 dryRun 创建(仅校验数据源是否合法)。取值:-true 是 -false 否

true
bodyobject

请求体参数

storageobject

数据源信息

endpointstring

odps endpoint

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

odps 数据源 ak

L***p
accessSecretstring

odps 数据源 ak secret

5**9a6
projectstring

odps 数据源项目名称

kubenest
partitionstring

分区信息

ds=20220713
tablestring

saro、odps 相关

item
namespacestring

saro 相关

dp-dev
pathstring

hdfs 相关

/ude_jobs/iflow_offline_data_access
ossPathstring

oss 数据源相关

/opensearch
bucketstring

Bucket 名称。

test-bucket
autoBuildIndexboolean

是否开启自动全量

true
processorobject

进程参数

argsstring

进程启动参数

{ "processInfos": [], "groupId": "opensearch", "containerConfigs": [], "priority": { "minor_priority": 0, "major_priority": 64 } }
resourcestring

资源信息

[{ "_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" }] }] }]
extendobject

扩展信息。

saroobject

saro 数据源信息

pathstring

路径

/
versionstring

版本号

1
hdfsobject

hdfs 信息

pathstring

hdfs 数据源路径。

ymsh-service/src/main/java/cn/ymsh/util/jd
odpsobject

odps 数据源信息

partitionsobject

数据源的分区信息

string

数据源的分区信息

ds=20230824
ossobject

oss 信息

pathstring

oss 数据源路径

oss://test
swiftobject

增量 swift 信息

zkstring

zk

zk
topicstring

topic

ha-cn-pl32rf0****_test_api

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

93A9E542-8CF8-5BA6-99AB-94C0FE520429
resultobject

返回结果。

{}

示例

正常返回示例

JSON格式

{
  "requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": {}
}

错误码

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