全部产品
Search
文档中心

智能开放搜索 OpenSearch:GetIndexOnlineStrategy - 获取某一索引在线策略

更新时间:Oct 16, 2024

获取索引在线生效策略。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:GetIndexOnlineStrategyget
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

请求语法

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}/indexes/{indexName}/online-strategy HTTP/1.1

请求参数

名称类型必填描述示例值
instanceIdstring

实例 id

ha-cn-pl32rf0****
dataSourceNamestring

数据源名称。

ha-cn-pl32rf0****_api_test
deployNamestring

机房

vpc_hz_domain_1
indexNamestring

索引名称

test_api

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

FE03180A-0E29-5474-8A86-33F0683294A4
resultobject

返回结果。

changeRateinteger

索引变化率

20

示例

正常返回示例

JSON格式

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {
    "changeRate": 20
  }
}

错误码

访问错误中心查看更多错误码。