你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Query Keys - List By Search Service

返回给定搜索服务的查询 API 密钥列表。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys?api-version=2023-11-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。

searchServiceName
path True

string

与指定资源组关联的搜索服务的名称。

subscriptionId
path True

string

Microsoft Azure 订阅的唯一标识符。 可以从 Azure 资源管理器 API、命令行工具或门户获取此值。

api-version
query True

string

要用于每个请求的 API 版本。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string

uuid

客户端生成的用于标识此请求的 GUID 值。 如果指定,则会将其包含在响应信息中,作为跟踪请求的一种方式。

响应

名称 类型 说明
200 OK

ListQueryKeysResult

给定搜索服务的所有查询键都已成功检索,并且都在响应中。 可以使用任何查询键作为数据平面 REST API 或 Azure SDK 中“api-key”参数的值,对搜索索引的文档集合执行只读操作,例如按 ID 查询和查找文档。

Other Status Codes

CloudError

HTTP 404 (找不到) :找不到订阅、资源组或搜索服务。 HTTP 409 (冲突) :禁用指定的订阅。

安全性

azure_auth

Microsoft Entra ID OAuth2 授权流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

SearchListQueryKeysBySearchService

示例请求

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2023-11-01

示例响应

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another query API key>"
    }
  ]
}

定义

名称 说明
CloudError

包含有关 API 错误的信息。

CloudErrorBody

使用错误代码和消息描述特定的 API 错误。

ListQueryKeysResult

包含给定搜索服务的查询 API 密钥的响应。

QueryKey

描述仅对查询操作具有权限的给定搜索服务的 API 密钥。

CloudError

包含有关 API 错误的信息。

名称 类型 说明
error

CloudErrorBody

使用错误代码和消息描述特定的 API 错误。

CloudErrorBody

使用错误代码和消息描述特定的 API 错误。

名称 类型 说明
code

string

描述错误条件的错误代码比 HTTP 状态代码更精确。 可用于以编程方式处理特定错误情况。

details

CloudErrorBody[]

包含与此错误相关的嵌套错误。

message

string

详细描述错误并提供调试信息的消息。

target

string

特定错误的目标 (例如,错误) 中属性的名称。

ListQueryKeysResult

包含给定搜索服务的查询 API 密钥的响应。

名称 类型 说明
nextLink

string

可用于查询查询密钥的下一页的请求 URL。 当请求的查询键总数超过最大页面大小时返回。

value

QueryKey[]

搜索服务的查询密钥。

QueryKey

描述仅对查询操作具有权限的给定搜索服务的 API 密钥。

名称 类型 说明
key

string

查询 API 密钥的值。

name

string

查询 API 密钥的名称;可能为空。