GetInstanceDetail - 获取实例详情

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
milvus:GetInstanceDetailget
  • Instance
    acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

POST /webapi/cluster/detail

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

c-123xxx

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 请求状态码。

200
RequestIdstring

请求 ID。

ABCD-1234-5678-EFGH
Successboolean

请求是否成功。

true
ErrCodestring

错误码。

Instance.NotFound
ErrMessagestring

错误信息。

Failed to find instance c-123xxx
Dataobject

返回数据。

InstanceIdstring

实例 ID。

c-123xxx
BeginTimelong

开始时间。

1716863508000
RunningTimelong

运行时间。

1743679
ExpireTimelong

过期时间。

1721664000000
RegionIdstring

地域。

cn-beijing
ZoneIdstring

可用区。

cn-beijing-g
InstanceStatusstring

实例状态。取值范围:

  • creating:创建中。
  • running:运行中。
  • updating:升级中。集群升降配、配置变更和开关公网等。
  • disable:不可用。集群已经过期,需要续费激活。
  • deleting:删除中。
  • deleted:已删除。
running
PackageTypestring

规格详情。取值范围:

  • trial:入门版。
  • standard:标准版。
standard
ClusterInfoobject

实例详情。

MilvusResourceInfoListarray<object>

资源详情。

object
ComponentTypestring

组件类型。取值范围:

  • standalone
  • proxy
  • mix_coordinator
  • query
  • index
  • data
standalone
CuNuminteger

CU 数量。

8
Replicainteger

副本数量。

2
DiskSizeinteger

磁盘大小。

100
DiskTypestring

磁盘类型。

essd
IntranetUrlstring

内网地址。

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

公网地址。

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

总 CU 数量。

24
TotalDiskSizeinteger

总磁盘数量。

500
ProxyPortinteger

Proxy 端口。

19530
AttuPortinteger

Attu 组件端口。

3000
OssStorageTimestamplong

OSS 存储指标时间。

1718604000000
OssStorageSizestring

OSS 存储数据大小。

125.15 GB
VpcIdstring

专有网络 ID。

vpc-123xxx
VswIdstring

交换机 ID。

vsw-123xxx
SgIdstring

安全组 ID。

sg-123xxx
OpenPublicNetboolean

是否开启公网。

true
ClusterNamestring

实例名称。

aliyun-test
PayTypeinteger

付费类型。取值范围:

  • 0:按量付费。
  • 1:包年包月。
1
BucketNamestring

Bucket 名称。

milvus-test
BucketPathstring

Bucket 地址。

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

内核版本。

2.4
AclIdstring

公网访问控制 AclId。

acl-123xxx
UserConfigstring

用户自定义配置。

dataCoord:\n segment:\n maxSize: 1024
TemplateVersionstring

软件栈版本。

2.4.1-1.0-0.0.1
ProductCodestring

商品 Code。

milvus_milvuspre_public_cn
ResourceGroupIdstring

资源组 id

rg-123xxx
AccessDeniedDetailstring

权限校验失败详情。

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

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "ABCD-1234-5678-EFGH",
  "Success": true,
  "ErrCode": "Instance.NotFound",
  "ErrMessage": "Failed to find instance c-123xxx",
  "Data": {
    "InstanceId": "c-123xxx",
    "BeginTime": 1716863508000,
    "RunningTime": 1743679,
    "ExpireTime": 1721664000000,
    "RegionId": "cn-beijing",
    "ZoneId": "cn-beijing-g",
    "InstanceStatus": "running",
    "PackageType": "standard",
    "ClusterInfo": {
      "MilvusResourceInfoList": [
        {
          "ComponentType": "standalone",
          "CuNum": 8,
          "Replica": 2,
          "DiskSize": 100,
          "DiskType": "essd"
        }
      ],
      "IntranetUrl": "c-123xxx-internal.milvus.aliyuncs.com",
      "InternetUrl": "c-123xxx-.milvus.aliyuncs.com",
      "TotalCuNum": 24,
      "TotalDiskSize": 500,
      "ProxyPort": 19530,
      "AttuPort": 3000,
      "OssStorageTimestamp": 1718604000000,
      "OssStorageSize": "125.15 GB"
    },
    "VpcId": "vpc-123xxx",
    "VswId": "vsw-123xxx",
    "SgId": "sg-123xxx",
    "OpenPublicNet": true,
    "ClusterName": "aliyun-test",
    "PayType": 1,
    "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",
    "Version": "2.4",
    "AclId": "acl-123xxx",
    "UserConfig": "dataCoord:\\n  segment:\\n    maxSize: 1024",
    "TemplateVersion": "2.4.1-1.0-0.0.1",
    "ProductCode": "milvus_milvuspre_public_cn",
    "ResourceGroupId": "rg-123xxx",
    "MeasureConfig": {
      "ProxyNodeCuNum": 0,
      "IndexNodeCuNum": 0,
      "QueryNodeCuNum": 0,
      "DataNodeCuNum": 0,
      "MixCoodinatorNodeCuNum": 0,
      "IndexNodeReplica": 0,
      "QueryNodeReplica": 0,
      "DataNodeReplica": 0,
      "MixCoodinatorNodeReplica": 0,
      "ProxyNodeReplica": 0
    }
  },
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-25OpenAPI 返回结构发生变更查看变更详情