Get Deployment App Search Resource Info
editGet Deployment App Search Resource Info
editGet info about an App Search Resource belonging to a given Deployment.
Request
editGET /api/v1/deployments/{deployment_id}/appsearch/{ref_id}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. |
|
|
N |
If showing plans, whether to show values that are left at their default value (less readable but more informative). |
|
|
N |
Whether to include with the current and pending plan information the plan history- can be very large per cluster. |
|
|
N |
Whether to include with the current and pending plan information the attempt log - can be very large per cluster. |
|
|
N |
Whether to include the full current and pending plan information in the response - can be large per cluster. |
|
|
N |
Whether to show cluster settings in the response. |
Responses
edit-
200
-
Standard response.
-
404
-
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
]) - The error codes associated with the response
-
-
500
-
We have failed you. (code:
deployments.deployment_resource_no_longer_exists
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_resource_no_longer_exists
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/appsearch/{ref_id} \ -H "Authorization: ApiKey $ECE_API_KEY"