全部文档
当前文档

暂无内容

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

文档中心

实例-列表

接口说明

查询milvus实例列表,支持分页查询。

请求参数

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

默认0开始,为第一页

Limit String

请求是不传默认返回10条

FuzzySearch String

支持实例ID/实例名称 模糊搜索

SecBindingStatus String

支持过滤是否绑定安全组 可同模糊搜索一起使用

示例值:true | false

返回参数

参数名称
类型
描述
RequestId String
示例值:3f949628-e3e7-402e-b8c5-9032544a9a41
Code String
示例值:0
Message String
示例值:success
Offset Int

默认0开始,为第一页

示例值:0
Limit Int

每页最大记录数

示例值:10
Total Int

实例总数

示例值:2
Data Object[]

实例列表信息

InstanceName String

实例名称

示例值:jiajingguoeip
Az String

可用区名称_en

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

可用区名称_zh

示例值:可用区C
InstanceId String

实例ID

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

实例状态_en

示例值:RUNNING
StateName String

实例状态_zh

示例值:运行中
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

端口信息

示例值:19530
Type String

节点ip类型
vip
eip

示例值:vip
Resources Object
CU Object

资源信息

CU Int

配置个数(单位:cu)

示例值:1
Type String

资源类型code

示例值:capacity
TypeName String

资源类型Name

示例值:容量型
Users String[]

用户信息,暂不返回

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
CreateDateOrder String

创建时间

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

地域

示例值:cn-qingyangtest-1

请求示例

curl -X GET
'http://milvus.api.ksyun.com/?Action=ListInstance&Version=2023-10-10&Offset=xxx&Limit=xxx&FuzzySearch=xxx&SecBindingStatus=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":"3f949628-e3e7-402e-b8c5-9032544a9a41",
"Code":"0",
"Message":"success",
"Offset":0,
"Limit":10,
"Total":2,
"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":"容量型"
}
},
"Users":[
],
"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"
},
{
"InstanceName":"gyc_包月账单勿删",
"Az":"cn-beijing-6c",
"AzName":"可用区C",
"InstanceId":"175fdd9a-f58a-11ee-b925-9eebc040fb00",
"State":"RUNNING",
"StateName":"运行中",
"Engine":"milvus 2.3.2",
"CreateDate":"2024-04-08T17:26:34.151488",
"Addresses":[
{
"Host":"10.0.5.160",
"Port":19530,
"Type":"vip"
},
{
"Host":"120.92.123.3",
"Port":29530,
"Type":"eip"
}
],
"Resources":{
"CU":{
"CU":1,
"Type":"capacity",
"TypeName":"容量型"
}
},
"Users":[
],
"SecurityGroupList":[
"06ce4512-f7e1-11ee-ba3f-9eebc040fb00"
],
"ProjectId":"1672",
"ProjectName":"默认项目",
"BillType":1,
"ProductId":"d04595ac-f312-4f46-8dea-4d826f0e9a1b",
"ProductType":717,
"ProductWhat":1,
"CreateDateOrder":"2024-05-15 11:34:20",
"ServiceEndTime":"2024-06-14 23:59:59",
"Region":"cn-qingyangtest-1"
}
]
}

错误码

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

错误码
错误信息
Http状态码
描述
InvalidParameter无效参数400无效参数
TROVE_LIST_INSTANCE_ERROR查询实例列表异常400查询实例列表异常
NO_PROJECT_ACCESS用户未含有项目400用户未含有项目
纯净模式常规模式

纯净模式

点击可全屏预览文档内容