查询实例详情

功能介绍

查询实例详情

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases/{database_id}

表1 路径参数
参数	是否必选	参数类型	描述
eihealth_project_id	是	String	平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。最小长度：1 最大长度：128
project_id	是	String	华为云项目ID，您可以从获取项目ID中获取。最小长度：1 最大长度：128
database_id	是	String	数据库实例id 最小长度：1 最大长度：128

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。最小长度：1 最大长度：32768

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
id	String	实例id
name	String	实例名称
description	String	描述
template	TemplateRsp object	模板详情
creator	String	创建者
create_time	String	创建时间
update_time	String	更新时间
data_count	Long	数据条目
source_project_name	String	源项目名
source_project_id	String	源项目id
source_id	String	源实例id
is_prefab	Boolean	是否为预置实例

表4 TemplateRsp
参数	参数类型	描述
id	String	模板id
name	String	模板名称
description	String	模板描述
source_project_name	String	来源项目名称
source_project_id	String	来源项目id
source_template_id	String	来源模板id
creator	String	创建者
columns	Array of DatabaseColumnDto objects	数据库列信息列表
create_time	String	创建时间
primary_key	String	主键
is_prefab	Boolean	是否是预置模板

表5 DatabaseColumnDto
参数	参数类型	描述
name	String	列名最小长度：1 最大长度：55
type	String	列类型枚举值： Long String Double
description	String	列描述信息最小长度：0 最大长度：1024
nullable	Boolean	列是否允许为空
primary	Boolean	是否作为主键
searchable	Boolean	是否可查询
unique	Boolean	是否唯一
tips	String	查询参数格式的提示信息最小长度：0 最大长度：1024

请求示例

无

响应示例

状态码： 200

{
  "name" : "demo-instance",
  "description" : "description",
  "template" : {
    "id" : "44e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "name" : "demo-template",
    "description" : "description",
    "source_project_name" : "source project",
    "source_project_id" : "16e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "source_template_id" : "36e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "creator" : "demo-user",
    "columns" : [ {
      "name" : "column1",
      "type" : "Long",
      "description" : "description",
      "nullable" : false,
      "primary" : true,
      "searchable" : true,
      "unique" : true,
      "tips" : "tips"
    } ],
    "create_time" : "2021-01-29T09:10:27Z",
    "primary_key" : "ID,GROUP",
    "is_prefab" : false
  },
  "creator" : "demo-user",
  "create_time" : "2021-01-29T09:10:27Z",
  "update_time" : "2021-01-29T09:10:27Z",
  "data_count" : 1000,
  "source_project_name" : "source-project",
  "source_project_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
  "source_id" : "44e0f1b0-ac10-46a5-8fa7-b26831d7d488",
  "is_prefab" : false
}