Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| searchengine:ModifyDataSourceDeploy | update |
|
| 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 cluster ID. | ha-cn-0ju2rps6c08 |
| deployName | string | Yes | The name of the data center. | vpc_hz_domain_1 |
| dataSourceName | string | Yes | The name of the data source. | ha-cn-0ju2rps6c08_api_test |
| generationId | long | No | The ID of the full index version. | 1708674867 |
| dryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. The system only checks the validity of the data source. 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 of the MaxCompute data source. | ak |
| accessSecret | string | No | The AccessKey secret of the MaxCompute data source. | as |
| project | string | No | The name of the MaxCompute project that is used as the data source. | kubenest |
| partition | string | No | The partition in the MaxCompute table. | ds=20220713 |
| table | string | No | The name of the MaxCompute table that is used as the data source. | item |
| namespace | string | No | The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group. | dp-dev |
| path | string | No | The file path in the Apsara File Storage for HDFS file system. | /ude_jobs/iflow_offline_data_access |
| ossPath | string | No | The Object Storage Service (OSS) path. | /opensearch |
| bucket | string | No | The name of the OSS bucket. | test-bucket |
| autoBuildIndex | boolean | No | Specifies whether to enable the automatic full indexing feature. | true |
| processor | object | No | The parameters of the process. | |
| args | string | No | The startup parameters of the process. | {} |
| resource | string | No | The resource information. | {} |
| extend | object | No | The extended information. | |
| saro | object | No | The information about the SARO data source. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group. | |
| path | string | No | The path of the SARO data source. | / |
| version | string | No | The version number of the SARO data source. | 1 |
| hdfs | object | No | The information about the Apsara File Storage for HDFS data source. | |
| path | string | No | The path of the Apsara File Storage for 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 partitions in the MaxCompute table. | |
| string | No | The partition in the MaxCompute table. | 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 the incremental data source Swift. | |
| zk | string | No | zk | zk |
| topic | string | No | The topic. | ha-cn-0ju2rps6c08_api |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
"result": {}
}Error codes
For a list of error codes, visit the Service error codes.