AI 助理
文档备案控制台
官方文档
首页 向量检索服务 Milvus 版 开发参考 API参考 API目录 其他 GetInstanceDetail - 获取实例详情

GetInstanceDetail - 获取实例详情

更新时间：
复制 MD 格式
我的收藏

获取单个实例的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

milvus:GetInstanceDetail

get

*Instance

acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}

 无 无

请求语法

POST /webapi/cluster/detail HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

否

实例 ID。

c-123xxx

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

权限校验失败详情。

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }
Data

object

返回数据。

AclId

string

公网访问控制 AclId。

acl-123xxx
BeginTime

integer

开始时间。

1716863508000
BucketName

string

Bucket 名称。

milvus-test
BucketPath

string

Bucket 地址。

https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx
ClusterInfo

object

实例详情。

AttuPort

integer

Attu 组件端口。

3000
CaCertUrl

string

CA 证书 HTTPS 下载地址

https://example.com/ca.pem
CertificateTrust

string

证书信任类型

privateCA
InternetUrl

string

公网地址。

c-123xxx-.milvus.aliyuncs.com
IntranetUrl

string

内网地址。

c-123xxx-internal.milvus.aliyuncs.com
MilvusResourceInfoList

array<object>

资源详情。

array<object>

ComponentType

string

组件类型。取值范围：

  • standalone

  • proxy

  • mix_coordinator

  • query

  • index

  • data

standalone
CuNum

integer

CU 数量。

8
CuRatio

integer

CU 规格。取值范围：

  • 4：1core 对应 4GB。

  • 8：1core 对应 8GB。

4
DiskSize

integer

磁盘大小。

100
DiskType

string

磁盘类型。

essd
PayType

string

Replica

integer

副本数量。

2
ZoneId

string

dataDiskEnabled

boolean

数据盘是否启用

true
dataDiskSize

integer

数据盘容量，单位 GiB

100
dataDiskStorageClass

string

数据盘 StorageClass

alicloud-disk-essd-pl1
podsList

array<object>

object

podId

string

podName

string

OssStorageSize

string

OSS 存储数据大小。

125.15 GB
OssStorageTimestamp

integer

OSS 存储指标时间。

1718604000000
ProxyPort

integer

Proxy 端口。

19530
SecureInternetUrl

string

TLS 公网域名

c-example.secure.milvus.aliyuncs.com
SecureIntranetUrl

string

TLS 内网域名

c-example-internal.secure.milvus.aliyuncs.com
SecureProxyPort

integer

TLS 连接端口

443
TotalCuNum

integer

总 CU 数量。

24
TotalDiskSize

integer

总磁盘数量。

500
ClusterName

string

实例名称。

aliyun-test
EnableHa

boolean

是否高可用

true
Encrypted

string

ExpireTime

integer

过期时间。

1721664000000
HighAvailability

object

CurrentActiveAZ

string

Mode

string

PrimaryZoneId

string

SecondaryZoneId

string

InstanceId

string

实例 ID。

c-123xxx
InstanceStatus

string

实例状态。取值范围：

  • creating：创建中。

  • running：运行中。

  • updating：升级中。集群升降配、配置变更和开关公网等。

  • disable：不可用。集群已经过期，需要续费激活。

  • deleting：删除中。

  • deleted：已删除。

running
KmsKeyId

string

MaintainablePeriod

string

MeasureConfig

object

配置信息

DataNodeCuNum

integer

Data 节点 Cu 数

4
DataNodeReplica

integer

Data 节点副本数

2
IndexNodeCuNum

integer

Index 节点 Cu 数

4
IndexNodeReplica

integer

Index 节点副本数

2
MixCoodinatorNodeCuNum

integer

MixCoordinator 节点 Cu 数

4
MixCoodinatorNodeReplica

integer

MixCoordinator 节点副本数

2
ProxyNodeCuNum

integer

Proxy 节点 Cu 数

4
ProxyNodeReplica

integer

Proxy 节点副本数

2
QueryNodeCuNum

integer

Query 节点 Cu 数

4
QueryNodeReplica

integer

Query 节点副本数

2
MultiZoneMode

string

Single,Two,Three

NodeType

string

节点类型。取值范围：

  • perf：性能型。

  • cap：容量型。

perf
OpenPublicNet

boolean

是否开启公网。

true
PackageType

string

规格详情。取值范围：

  • trial：入门版。

  • standard：标准版。

standard
PayType

integer

付费类型。取值范围：

  • 0：按量付费。

  • 1：包年包月。

1
ProductCode

string

商品 Code。

milvus_milvuspre_public_cn
RegionId

string

地域。

cn-beijing
ResourceGroupId

string

资源组 id

rg-123xxx
RunningTime

integer

运行时间。

1743679
SgId

string

安全组 ID。

sg-123xxx
Tags

array<object>

tag 信息

object

tag 信息

Key

string

tag 的 key

key1
Value

string

tag 的 value

value1
TemplateVersion

string

软件栈版本。

2.4.1-1.0-0.0.1
UserConfig

string

用户自定义配置。

dataCoord:\n segment:\n maxSize: 1024
VSwitches

array<object>

object

VswId

string

ZoneId

string

Version

string

内核版本。

2.4
VpcId

string

专有网络 ID。

vpc-123xxx
VswId

string

交换机 ID。

vsw-123xxx
ZoneId

string

可用区。

cn-beijing-g
maintainablePeriodTimeZone

string

ErrCode

string

错误码。

Instance.NotFound
ErrMessage

string

错误信息。

Failed to find instance c-123xxx
HttpStatusCode

integer

HTTP 请求状态码。

200
RequestId

string

请求 ID。

ABCD-1234-5678-EFGH
Success

boolean

请求是否成功。

true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }",
  "Data": {
    "AclId": "acl-123xxx",
    "BeginTime": 1716863508000,
    "BucketName": "milvus-test",
    "BucketPath": "https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx",
    "ClusterInfo": {
      "AttuPort": 3000,
      "CaCertUrl": "https://example.com/ca.pem",
      "CertificateTrust": "privateCA",
      "InternetUrl": "c-123xxx-.milvus.aliyuncs.com",
      "IntranetUrl": "c-123xxx-internal.milvus.aliyuncs.com",
      "MilvusResourceInfoList": [
        {
          "ComponentType": "standalone",
          "CuNum": 8,
          "CuRatio": 4,
          "DiskSize": 100,
          "DiskType": "essd",
          "PayType": "",
          "Replica": 2,
          "ZoneId": "",
          "dataDiskEnabled": true,
          "dataDiskSize": 100,
          "dataDiskStorageClass": "alicloud-disk-essd-pl1",
          "podsList": [
            {
              "podId": "",
              "podName": ""
            }
          ]
        }
      ],
      "OssStorageSize": "125.15 GB",
      "OssStorageTimestamp": 1718604000000,
      "ProxyPort": 19530,
      "SecureInternetUrl": "c-example.secure.milvus.aliyuncs.com",
      "SecureIntranetUrl": "c-example-internal.secure.milvus.aliyuncs.com",
      "SecureProxyPort": 443,
      "TotalCuNum": 24,
      "TotalDiskSize": 500
    },
    "ClusterName": "aliyun-test",
    "EnableHa": true,
    "Encrypted": "",
    "ExpireTime": 1721664000000,
    "HighAvailability": {
      "CurrentActiveAZ": "",
      "Mode": "",
      "PrimaryZoneId": "",
      "SecondaryZoneId": ""
    },
    "InstanceId": "c-123xxx",
    "InstanceStatus": "running",
    "KmsKeyId": "",
    "MaintainablePeriod": "",
    "MeasureConfig": {
      "DataNodeCuNum": 4,
      "DataNodeReplica": 2,
      "IndexNodeCuNum": 4,
      "IndexNodeReplica": 2,
      "MixCoodinatorNodeCuNum": 4,
      "MixCoodinatorNodeReplica": 2,
      "ProxyNodeCuNum": 4,
      "ProxyNodeReplica": 2,
      "QueryNodeCuNum": 4,
      "QueryNodeReplica": 2
    },
    "MultiZoneMode": "",
    "NodeType": "perf",
    "OpenPublicNet": true,
    "PackageType": "standard",
    "PayType": 1,
    "ProductCode": "milvus_milvuspre_public_cn",
    "RegionId": "cn-beijing",
    "ResourceGroupId": "rg-123xxx",
    "RunningTime": 1743679,
    "SgId": "sg-123xxx",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "TemplateVersion": "2.4.1-1.0-0.0.1",
    "UserConfig": "dataCoord:\\n  segment:\\n    maxSize: 1024",
    "VSwitches": [
      {
        "VswId": "",
        "ZoneId": ""
      }
    ],
    "Version": "2.4",
    "VpcId": "vpc-123xxx",
    "VswId": "vsw-123xxx",
    "ZoneId": "cn-beijing-g",
    "maintainablePeriodTimeZone": ""
  },
  "ErrCode": "Instance.NotFound",
  "ErrMessage": "Failed to find instance c-123xxx",
  "HttpStatusCode": 200,
  "RequestId": "ABCD-1234-5678-EFGH",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：GetInstance - 获取实例详情下一篇：ListInstances - 获取实例列表