查询配置项列表

功能介绍

获取配置项详情，以列表形式返回。

URI

GET /v3/{project_id}/ai-mgr/configmaps

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID

表2 Query参数
参数	是否必选	参数类型	描述
provider	否	String	服务提供者：ief或hilens，默认为hilens。
name	否	String	配置项名称，模糊匹配。
workspace_id	否	String	工作空间ID，默认为注册账号/子账号的default工作空间，可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID
limit	否	Integer	每页显示的条目数量，取值范围1~1000，默认值为1000。
offset	否	Integer	查询的起始位置，取值范围为非负整数，默认为0。
sort	否	String	排序方式，可根据名称、创建时间、更新时间排序枚举值：name，created_at，updated_at。sort默认升序，如sort=name，降序：sort=name%3Adesc。不填默认为sort=created_at%3Adesc。
tag_key	否	String	格式为{tag_key}={tag_value}，支持多对tag或查询。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	租户Token。获取方法请参见获取Token

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
count	Integer	配置项数量
configmaps	Array of ConfigMap objects	配置项详情

表5 ConfigMap
参数	参数类型	描述
configs	Array of Config objects	配置列表
created_at	String	创建时间
description	String	描述
id	String	配置项ID
name	String	名称
project_id	String	项目ID
tags	Array of Tag objects	标签列表
type	String	类型
updated_at	String	更新时间
workspace_id	String	工作空间ID

表6 Config
参数	参数类型	描述
key	String	配置项key，最大长度63个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”
value	String	配置项value，每个值最大长度10000个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

表7 Tag
参数	参数类型	描述
key	String	标签键，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”
value	String	标签值，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

请求示例

获取配置项详情列表

GET https://{endpoint}/v3/{project_id}/ai-mgr/configmaps

Request Header:  Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例

状态码： 200

请求成功

{
  "count" : "integer",
  "configmaps" : [ {
    "configs" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "created_at" : "string",
    "description" : "string",
    "id" : "string",
    "name" : "string",
    "project_id" : "string",
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "type" : "string",
    "updated_at" : "string",
    "workspace_id" : "string"
  } ]
}