ModifyDataSourceDeploy - OpenSearch - Alibaba Cloud Documentation Center

Modifies the deployment information of a data source.

Operation description

Method

PUT

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:ModifyDataSourceDeploy

update

*Instance

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

None

Request syntax

PUT /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
generationId	integer	No	The full index version.	1708674867
dryRun	boolean	No	Specifies whether to perform a dry run. A dry run checks the validity of the request parameters without performing the actual operation. Valid values: `true` and `false`.	true
body	object	No	The request body.
storage	object	No	The information about the data source.
endpoint	string	No	The endpoint of the MaxCompute data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	No	The AccessKey ID for the MaxCompute data source.	L***p
accessSecret	string	No	The AccessKey secret for the MaxCompute data source.	5**9a6
project	string	No	The name of the MaxCompute project.	kubenest
partition	string	No	The partition information.	ds=20220713
table	string	No	The name of the table. This parameter applies to saro and MaxCompute data sources.	item
namespace	string	No	The namespace. This parameter applies to saro data sources.	dp-dev
path	string	No	The path. This parameter applies to HDFS data sources.	/ude_jobs/iflow_offline_data_access
ossPath	string	No	The path of the data in the OSS bucket. This parameter applies to OSS data sources.	/opensearch
bucket	string	No	The name of the bucket.	test-bucket
catalog	string	No	The name of the data catalog. This parameter applies to Data Lake Formation (DLF) data sources.	test-catalog
database	string	No	The database name. This parameter applies to DLF data sources.	test-database
tag	string	No	The tag. This parameter applies to DLF data sources.	test
tableFormat	string	No	The table format. This parameter applies to DLF data sources.	paimon lance object
autoBuildIndex	boolean	No	Specifies whether to automatically trigger a full indexing task.	true
processor	object	No	The parameters for the process.
args	string	No	The startup arguments for the process.	{ "processInfos": [], "groupId": "opensearch", "containerConfigs": [], "priority": { "minor_priority": 0, "major_priority": 64 } }
resource	string	No	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	No	The extended information.
saro	object	No	The information about the saro data source.
path	string	No	The path.	/
version	string	No	The version number.	1
hdfs	object	No	The information about the HDFS data source.
path	string	No	The path of the HDFS data source.	ymsh-service/src/main/java/cn/ymsh/util/jd
odps	object	No	The information about the MaxCompute data source.
partitions	object	No	The partition information of the data source.
	string	No	A key-value pair that represents a partition. The key is the partition key, and the value is the partition value.	ds=20230824
oss	object	No	The information about the OSS data source.
path	string	No	The path of the OSS data source.	oss://test
swift	object	No	The information about incremental data from Swift.
zk	string	No	The ZooKeeper path.	zk
topic	string	No	The topic name.	ha-cn-pl32rf0****_test_api

Response elements

Element	Type	Description	Example
	object
requestId	string	The ID of the request.	93A9E542-8CF8-5BA6-99AB-94C0FE520429
result	object	The result of the request.	{}

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.