Aliases - List
Lists all aliases available for a search service.
GET {endpoint}/aliases?api-version=2024-05-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
The endpoint URL of the search service. |
api-version
|
query | True |
string |
Client Api Version. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
The tracking ID sent with the request to help with debugging. |
Responses
Name | Type | Description |
---|---|---|
200 OK | ||
Other Status Codes |
Error response. |
Examples
SearchServiceListAliases
Sample request
GET https://myservice.search.windows.net/aliases?api-version=2024-05-01-preview
Sample response
{
"value": [
{
"name": "production",
"indexes": [
"hotels"
]
},
{
"name": "staging",
"indexes": [
"testindex"
]
}
]
}
Definitions
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
List |
Response from a List Aliases request. If successful, it includes the associated index mappings for all aliases. |
Search |
Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
ListAliasesResult
Response from a List Aliases request. If successful, it includes the associated index mappings for all aliases.
Name | Type | Description |
---|---|---|
value |
The aliases in the Search service. |
SearchAlias
Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations.
Name | Type | Description |
---|---|---|
@odata.etag |
string |
The ETag of the alias. |
indexes |
string[] |
The name of the index this alias maps to. Only one index name may be specified. |
name |
string |
The name of the alias. |