Aliases - Get
별칭 정의를 검색합니다.
GET {endpoint}/aliases('{aliasName}')?api-version=2024-11-01-preview
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
alias
|
path | True |
string |
검색할 별칭의 이름입니다. |
|
endpoint
|
path | True |
string |
검색 서비스의 엔드포인트 URL입니다. |
|
api-version
|
query | True |
string |
클라이언트 API 버전입니다. |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
디버깅에 도움이 되도록 요청과 함께 전송된 추적 ID입니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
오류 응답입니다. |
예제
SearchServiceGetAlias
샘플 요청
GET https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2024-11-01-preview
샘플 응답
{
"name": "myalias",
"indexes": [
"preview-test"
]
}
정의
| Name | Description |
|---|---|
|
Error |
리소스 관리 오류 추가 정보입니다. |
|
Error |
오류 세부 정보입니다. |
|
Error |
오류 응답 |
|
Search |
별칭 이름에서 인덱스로의 매핑을 설명하는 인덱스 별칭을 나타냅니다. 지원되는 작업에 대한 인덱스 이름 대신 별칭 이름을 사용할 수 있습니다. |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| info |
object |
추가 정보입니다. |
| type |
string |
추가 정보 유형입니다. |
ErrorDetail
오류 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| additionalInfo |
오류 추가 정보입니다. |
|
| code |
string |
오류 코드입니다. |
| details |
오류 세부 정보입니다. |
|
| message |
string |
오류 메시지입니다. |
| target |
string |
오류 대상입니다. |
ErrorResponse
오류 응답
| Name | 형식 | Description |
|---|---|---|
| error |
오류 개체입니다. |
SearchAlias
별칭 이름에서 인덱스로의 매핑을 설명하는 인덱스 별칭을 나타냅니다. 지원되는 작업에 대한 인덱스 이름 대신 별칭 이름을 사용할 수 있습니다.
| Name | 형식 | Description |
|---|---|---|
| @odata.etag |
string |
별칭의 ETag입니다. |
| indexes |
string[] |
이 별칭이 매핑되는 인덱스의 이름입니다. 인덱스 이름은 하나만 지정할 수 있습니다. |
| name |
string |
별칭의 이름입니다. |