Aliases - Get

Reference

Service:: Search Service

API Version:: 2024-05-01-preview

Retrieves an alias definition.

GET {endpoint}/aliases('{aliasName}')?api-version=2024-05-01-preview

URI Parameters

Name	In	Required	Type	Description
aliasName	path	True	string	The name of the alias to retrieve.
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	SearchAlias
Other Status Codes	ErrorResponse	Error response.

Examples

SearchServiceGetAlias

Sample request

HTTP

GET https://myservice.search.windows.net/aliases('production')?api-version=2024-05-01-preview

Sample response

Status code:: 200

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
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.

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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

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.

Share via