ListAdvanceConfigDir - OpenSearch - Alibaba Cloud Documentation Center

Queries the files in an advanced configuration directory.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir?dirName={dirName}

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-tl32n3iu801
configName	string	Yes	The configuration name.	ha-cn-2r42ostoc01_online_config_v3
dirName	string	Yes	The name of the directory	/zones/general

Sample requests

GET /openapi/ha3/instances/ose-test1/advanced-configs

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The ID of the request.	2AE63638-5420-56DC-BF59-37D8174039A0
result	array<object>	The advanced configuration files.
	object	The result returned.
name	string	The cluster name.	file_name_1
fullPathName	string	The absolute path in which the file is stored.	"/path/wpd/nae"
isDir	boolean	Indicates whether the file is a directory. Valid values: true and false.	true
isTemplate	boolean	Indicates whether the file is a template. Valid values: true and false.	true

Sample responses

Success responses

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "name": "file_name_1",
      "fullPathName": "/path/wpd/nae",
      "isDir": true,
      "isTemplate": true
    }
  ]
}

Examples

Sample success responses

JSONformat

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": [
    {
      "name": "file_name_1",
      "fullPathName": "\"/path/wpd/nae\"",
      "isDir": true,
      "isTemplate": true
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.