文档

ListAdvanceConfigs - 获取高级配置列表

获取高级配置列表。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs?type=online

调试

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

授权信息

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

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

请求语法

GET /openapi/ha3/instances/{instanceId}/advanced-configs

请求参数

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

实例 ID

ha-cn-pl32rf0js04
typestring

高级配置类型: - online - offline (默认)

online

请求示例

GET /openapi/ha3/instances/ose-test1/advanced-configs

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id。

4FB0325E-8C37-5525-96AC-0333523170A3
resultobject []

高级配置列表

updateTimelong

更新时间

1631070464000
descstring

描述

test
filesobject []

文件名列表

namestring

文件名称

file_name_1
fullPathNamestring

绝对路径

/path/wpd/nae
isDirboolean

是否为目录。取值:-true:是-false:否

true
isTemplateboolean

是否是模板。取值:-true:是-false:否

true
contentstring

配置内容 http,git 请求时不为空

contentTypestring

配置内容的类型 (FILE, GIT, HTTP, ODPS)

namestring

高级配置名称

my_index
statusstring

高级配置状态 drafting: 草稿 used: 使用中 unused: 未使用 trash: 删除中

drafting

返回示例

正确返回

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "name": "my_index",
      "status": "drafting",
      "updateTime": 1631070464000,
      "desc":"test",
      "files":[
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ]
    },
    {
      "name": "my_index2",
      "status": "drafting",
      "updateTime": 1631070464000,
      "desc":"test",
      "files":[
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ]
    }
  ]
}

示例

正常返回示例

JSON格式

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": [
    {
      "updateTime": 1631070464000,
      "desc": "test",
      "files": [
        {
          "name": "file_name_1",
          "fullPathName": "/path/wpd/nae",
          "isDir": true,
          "isTemplate": true
        }
      ],
      "content": "",
      "contentType": "",
      "name": "my_index",
      "status": "drafting"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈