更新时间:2023-04-24 GMT+08:00
分享

查询配置项详情

功能介绍

根据配置项id查询某个配置项详情

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

config_map_id

String

配置项ID,从专业版HiLens控制台配置项管理获取配置项列表获取

project_id

String

项目ID。获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token。获取方法请参见获取Token

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

configmap

ConfigMap object

配置项详情

workspace_id

String

工作空间ID,默认为注册账号/子账号的default工作空间,可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID

表4 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

表5 Config

参数

参数类型

描述

key

String

配置项key,最大长度63个字符。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

value

String

配置项value,每个值最大长度10000个字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

表6 Tag

参数

参数类型

描述

key

String

标签键,最大长度36个字符。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

value

String

标签值,每个值最大长度43个字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

请求示例

获取某个配置项详情

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

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

响应示例

状态码: 200

请求成功

{
  "configmap" : {
    "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"
  },
  "workspace_id" : "string"
}

状态码

状态码

描述

200

请求成功

401

认证不通过

403

拒绝执行请求

404

请求的资源不存在

500

服务器内部错误

错误码

请参见错误码

相关文档