全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

实例-详情

接口说明

查询milvus实例详情,需指定实例id。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:DescribeInstance。
Version String
公共参数,本接口取值:2023-10-10。
InstanceId String

实例ID

返回参数

参数名称
类型
描述
RequestId String
示例值:af0bd03f-b7bb-4440-aed3-02d49ebf12e6
Code String
示例值:0
Message String
示例值:success
Data Object

返回数据域

InstanceName String

实例名称

示例值:jiajingguoeip
Az String

实例可用区Code

示例值:cn-beijing-6c
AzName String

实例可用区Name

示例值:可用区C
InstanceId String

实例ID

示例值:ae156302-0c52-11ef-bc9e-42f104612b0b
State String

实例状态Code:
CREATING 创建中
RUNNING 运行中
LOCKED 锁定
ERROR 异常
DELETING 删除中
UNKNOWN 未知

示例值:RUNNING
StateName String

实例状态Name

示例值:运行中
Engine String

实例版本

示例值:milvus 2.3.2
CreateDate String

创建时间

示例值:2024-05-07T17:17:51.926381
Addresses Object[]

实例节点地址信息列表

Host String

节点IP

示例值:10.0.5.55
Port Int

节点Port

示例值:19530
Type String

节点IP类型;
vip
eip

示例值:vip
Resources Object

资源配置

CU Object
CU Int

个数(单位为cu)

示例值:1
Type String

资源类型;
capacity 容量型

示例值:capacity
TypeName String

资源类型中文名称

示例值:容量型
SubnetId String

子网ID

示例值:e6d0922a-0a70-48e1-a32d-0ac958cc428d
VnetId String

虚拟网络ID

示例值:2b9c6c9b-a51e-4839-a437-1fa7b6c0a893
MonitorLink String

监控地址

示例值:http://120.92.210.40/milvus/ae156302-0c52-11ef-bc9e-42f104612b0b
Users Object[]

实例用户信息列表

Id String

用户ID

示例值:ae167c2e-0c52-11ef-bc9e-42f104612b0b
Name String

用户名称

示例值:admin
IsAdmin Boolean

是否为管理员:true、false

示例值:true
CreatedAt String

创建时间

示例值:2024-05-07T17:17:51.933563
SecurityGroupList String[]

安全组列表,现在暂不支持多安区组

示例值:06ce4512-f7e1-11ee-ba3f-9eebc040fb00
ProjectId String

项目ID

示例值:110171
ProjectName String

项目名称

示例值:DMP测试1
BillType Int

计费类型

示例值:87
ProductId String

商品ID

示例值:21ea1ebe-b513-430c-b4d1-19e9cd84715b
ProductType Int

商品类型ID

示例值:717
ProductWhat Int

商品购买作用
1=创建
3=更配

示例值:1
CreateDateOrder String

创建时间

示例值:2024-05-07 17:22:54
Region String

地域

示例值:cn-qingyangtest-1

请求示例

curl -X GET
'http://milvus.api.ksyun.com/?Action=DescribeInstance&Version=2023-10-10&InstanceId=xxx'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/json'
-H 'host: milvus.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'

返回示例

JSON格式

{
"RequestId":"af0bd03f-b7bb-4440-aed3-02d49ebf12e6",
"Code":"0",
"Message":"success",
"Data":{
"InstanceName":"jiajingguoeip",
"Az":"cn-beijing-6c",
"AzName":"可用区C",
"InstanceId":"ae156302-0c52-11ef-bc9e-42f104612b0b",
"State":"RUNNING",
"StateName":"运行中",
"Engine":"milvus 2.3.2",
"CreateDate":"2024-05-07T17:17:51.926381",
"Addresses":[
{
"Host":"10.0.5.55",
"Port":19530,
"Type":"vip"
},
{
"Host":"120.92.208.30",
"Port":29534,
"Type":"eip"
}
],
"Resources":{
"CU":{
"CU":1,
"Type":"capacity",
"TypeName":"容量型"
}
},
"SubnetId":"e6d0922a-0a70-48e1-a32d-0ac958cc428d",
"VnetId":"2b9c6c9b-a51e-4839-a437-1fa7b6c0a893",
"MonitorLink":"http://120.92.210.40/milvus/ae156302-0c52-11ef-bc9e-42f104612b0b",
"Users":[
{
"Id":"ae167c2e-0c52-11ef-bc9e-42f104612b0b",
"Name":"admin",
"IsAdmin":true,
"CreatedAt":"2024-05-07T17:17:51.933563"
}
],
"SecurityGroupList":[
"06ce4512-f7e1-11ee-ba3f-9eebc040fb00"
],
"ProjectId":"110171",
"ProjectName":"DMP测试1",
"BillType":87,
"ProductId":"21ea1ebe-b513-430c-b4d1-19e9cd84715b",
"ProductType":717,
"ProductWhat":1,
"CreateDateOrder":"2024-05-07 17:22:54",
"Region":"cn-qingyangtest-1"
}
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
InvalidParameter无效参数400无效参数
TROVE_DESC_INSTANCE_ERROR查询详情异常400查询详情异常
NO_PROJECT_ACCESS账户未拥有项目400账户未拥有当前实例所在项目
DESC_INSTANCE_ERROR实例不存在400实例不存在(订单是状态)
纯净模式常规模式

纯净模式

点击可全屏预览文档内容