获取单个实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
milvus:GetInstanceDetail | get |
|
| 无 |
请求语法
POST /webapi/cluster/detail
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 否 | 实例 ID。 | c-123xxx |
返回参数
示例
正常返回示例
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-25 | OpenAPI 返回结构发生变更 | 查看变更详情 |