GetInstanceDetail - 获取实例详情
获取单个实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
编辑调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
milvus-GetInstanceDetail-entry-authInfo-th-1">操作 | milvus-GetInstanceDetail-entry-authInfo-th-2">访问级别 | milvus-GetInstanceDetail-entry-authInfo-th-3">资源类型 | milvus-GetInstanceDetail-entry-authInfo-th-4">条件关键字 | milvus-GetInstanceDetail-entry-authInfo-th-5">关联操作 |
---|---|---|---|---|
milvus-GetInstanceDetail-entry-authInfo-0-tr-td-0">milvus:GetInstanceDetail | milvus-GetInstanceDetail-entry-authInfo-0-tr-td-1">get | milvus-GetInstanceDetail-entry-authInfo-0-tr-td-2">
| milvus-GetInstanceDetail-entry-authInfo-0-tr-td-3">
| milvus-GetInstanceDetail-entry-authInfo-0-tr-td-4">无 |
请求语法
POST /webapi/cluster/detail
请求参数
milvus-GetInstanceDetail-parameters-entry-th-1">名称 | milvus-GetInstanceDetail-parameters-entry-th-2">类型 | milvus-GetInstanceDetail-parameters-entry-th-3">必填 | milvus-GetInstanceDetail-parameters-entry-th-4">描述 | milvus-GetInstanceDetail-parameters-entry-th-5">示例值 |
---|---|---|---|---|
InstanceId | string | 否 | 实例 ID。 | c-123xxx |
返回参数
milvus-GetInstanceDetail-resultMapping-entry-th-1">名称 | milvus-GetInstanceDetail-resultMapping-entry-th-2">类型 | milvus-GetInstanceDetail-resultMapping-entry-th-3">描述 | milvus-GetInstanceDetail-resultMapping-entry-th-4">示例值 |
---|---|---|---|
object | |||
HttpStatusCode | integer | HTTP 请求状态码。 | 200 |
RequestId | string | 请求 ID。 | ABCD-1234-5678-EFGH |
Success | boolean | 请求是否成功。 | true |
ErrCode | string | 错误码。 | Instance.NotFound |
ErrMessage | string | 错误信息。 | Failed to find instance c-123xxx |
Data | object | 返回数据。 | |
InstanceId | string | 实例 ID。 | c-123xxx |
BeginTime | long | 开始时间。 | 1716863508000 |
RunningTime | long | 运行时间。 | 1743679 |
ExpireTime | long | 过期时间。 | 1721664000000 |
RegionId | string | 地域。 | cn-beijing |
ZoneId | string | 可用区。 | cn-beijing-g |
InstanceStatus | string | 实例状态。取值范围:
| running |
PackageType | string | 规格详情。取值范围:
| standard |
ClusterInfo | object | 实例详情。 | |
MilvusResourceInfoList | array<object> | 资源详情。 | |
object | |||
ComponentType | string | 组件类型。取值范围:
| standalone |
CuNum | integer | CU 数量。 | 8 |
Replica | integer | 副本数量。 | 2 |
DiskSize | integer | 磁盘大小。 | 100 |
DiskType | string | 磁盘类型。 | essd |
IntranetUrl | string | 内网地址。 | c-123xxx-internal.milvus.aliyuncs.com |
InternetUrl | string | 公网地址。 | c-123xxx-.milvus.aliyuncs.com |
TotalCuNum | integer | 总 CU 数量。 | 24 |
TotalDiskSize | integer | 总磁盘数量。 | 500 |
ProxyPort | integer | Proxy 端口。 | 19530 |
AttuPort | integer | Attu 组件端口。 | 3000 |
OssStorageTimestamp | long | OSS 存储指标时间。 | 1718604000000 |
OssStorageSize | string | OSS 存储数据大小。 | 125.15 GB |
VpcId | string | 专有网络 ID。 | vpc-123xxx |
VswId | string | 交换机 ID。 | vsw-123xxx |
SgId | string | 安全组 ID。 | sg-123xxx |
OpenPublicNet | boolean | 是否开启公网。 | true |
ClusterName | string | 实例名称。 | aliyun-test |
PayType | integer | 付费类型。取值范围:
| 1 |
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 |
Version | string | 内核版本。 | 2.4 |
AclId | string | 公网访问控制 AclId。 | acl-123xxx |
UserConfig | string | 用户自定义配置。 | dataCoord:\n segment:\n maxSize: 1024 |
TemplateVersion | string | 软件栈版本。 | 2.4.1-1.0-0.0.1 |
ProductCode | string | 商品 Code。 | milvus_milvuspre_public_cn |
ResourceGroupId | string | 资源组 id | rg-123xxx |
AccessDeniedDetail | string | 权限校验失败详情。 | { "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\" }"
}
ListInstances - 获取实例列表
获取当前账号下Milvus实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
编辑调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
milvus-ListInstances-entry-authInfo-th-1">操作 | milvus-ListInstances-entry-authInfo-th-2">访问级别 | milvus-ListInstances-entry-authInfo-th-3">资源类型 | milvus-ListInstances-entry-authInfo-th-4">条件关键字 | milvus-ListInstances-entry-authInfo-th-5">关联操作 |
---|---|---|---|---|
milvus-ListInstances-entry-authInfo-0-tr-td-0">milvus:ListInstances | milvus-ListInstances-entry-authInfo-0-tr-td-1">get | milvus-ListInstances-entry-authInfo-0-tr-td-2">
| milvus-ListInstances-entry-authInfo-0-tr-td-3">
| milvus-ListInstances-entry-authInfo-0-tr-td-4">无 |
请求语法
POST /webapi/order/list
请求参数
milvus-ListInstances-parameters-entry-th-1">名称 | milvus-ListInstances-parameters-entry-th-2">类型 | milvus-ListInstances-parameters-entry-th-3">必填 | milvus-ListInstances-parameters-entry-th-4">描述 | milvus-ListInstances-parameters-entry-th-5">示例值 |
---|---|---|---|---|
ClusterName | string | 否 | 实例名称。 | milvus-test |
ClusterId | string | 否 | 实例 ID。 | c-123xxx |
PageNumber | integer | 否 | 页码。 | 1 |
PageSize | integer | 否 | 分页大小。 | 10 |
RegionId | string | 否 | 地域。 | cn-beijing |
ResourceGroupId | string | 否 | 资源组 id | rg-123xxx |
返回参数
milvus-ListInstances-resultMapping-entry-th-1">名称 | milvus-ListInstances-resultMapping-entry-th-2">类型 | milvus-ListInstances-resultMapping-entry-th-3">描述 | milvus-ListInstances-resultMapping-entry-th-4">示例值 |
---|---|---|---|
object | |||
HttpStatusCode | integer | HTTP 请求状态码。 | 200 |
RequestId | string | 请求 ID。 | ABCD-1234-5678-EFGH |
Success | boolean | 请求是否成功。 | true |
ErrCode | string | 错误码。 | Instance.NotFound |
ErrMessage | string | 错误信息。 | Failed to find instance c-123xxx |
Data | array<object> | 返回数据。 | |
object | |||
InstanceId | string | 实例 ID。 | c-123xxx |
BeginTime | long | 开始时间。 | 1718608505000 |
RunningTime | integer | 运行时间。 | 536611 |
ExpireTime | long | 过期时间。 | 1721232000000 |
RegionId | string | 地域。 | cn-beijing |
ZoneId | string | 可用区。 | cn-beijing-g |
InstanceStatus | string | 实例状态。取值范围:
| running |
ClusterName | string | 实例名称。 | milvus-test |
PackageType | string | 规格详情。取值范围:
| trial |
ClusterInfo | object | 实例详情。 | |
MilvusResourceInfoList | array<object> | 资源详情。 | |
object | |||
ComponentType | string | 组件类型。取值范围:
| standalone |
CuNum | integer | CU 数量。 | 16 |
Replica | integer | 副本数量。 | 1 |
DiskSize | integer | 磁盘大小。 | 100 |
DiskType | string | 磁盘类型。 | essd |
IntranetUrl | string | 内网地址。 | c-123xxx-internal.milvus.aliyuncs.com |
InternetUrl | string | 公网地址。 | c-123xxx.milvus.aliyuncs.com |
TotalCuNum | integer | CU 数量。 | 24 |
TotalDiskSize | integer | 磁盘总量。 | 500 |
ProxyPort | integer | Proxy 端口。 | 19530 |
AttuPort | integer | Attu 组件端口。 | 3000 |
VpcId | string | 专有网络 ID。 | vpc-123xxx |
VswId | string | 交换机 ID。 | vsw-123xxx |
SgId | string | 安全组 ID。 | sg-123xxx |
OpenPublicNet | boolean | 是否开启公网。 | true |
PayType | integer | 付费类型。取值范围:
| 1 |
ProductCode | string | 商品 Code | milvus_milvuspre_public_cn |
ResourceGroupId | string | 资源组 id | rg-123xxx |
Total | integer | 总数。 | 15 |
AccessDeniedDetail | string | 权限校验失败详情。 | { "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": 1718608505000,"RunningTime": 536611,"ExpireTime": 1721232000000,"RegionId": "cn-beijing","ZoneId": "cn-beijing-g","InstanceStatus": "running","ClusterName": "milvus-test","PackageType": "trial","ClusterInfo": {"MilvusResourceInfoList": [{"ComponentType": "standalone","CuNum": 16,"Replica": 1,"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},"VpcId": "vpc-123xxx","VswId": "vsw-123xxx","SgId": "sg-123xxx","OpenPublicNet": true,"PayType": 1,"ProductCode": "milvus_milvuspre_public_cn","ResourceGroupId": "rg-123xxx"}],"Total": 15,"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxxx\", \"EncodedDiagnosticMessage\": \"xxxx\", \"AuthPrincipalType\": \"SubUser\", \"AuthPrincipalDisplayName\": \"xxxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"milvus:xxxx\" }"
}
UpdateInstanceName - 修改实例名称
修改实例名称。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
编辑调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
milvus-UpdateInstanceName-entry-authInfo-th-1">操作 | milvus-UpdateInstanceName-entry-authInfo-th-2">访问级别 | milvus-UpdateInstanceName-entry-authInfo-th-3">资源类型 | milvus-UpdateInstanceName-entry-authInfo-th-4">条件关键字 | milvus-UpdateInstanceName-entry-authInfo-th-5">关联操作 |
---|---|---|---|---|
milvus-UpdateInstanceName-entry-authInfo-0-tr-td-0">milvus:UpdateInstanceName | milvus-UpdateInstanceName-entry-authInfo-0-tr-td-1">update | milvus-UpdateInstanceName-entry-authInfo-0-tr-td-2">
| milvus-UpdateInstanceName-entry-authInfo-0-tr-td-3">
| milvus-UpdateInstanceName-entry-authInfo-0-tr-td-4">无 |
请求语法
POST /webapi/cluster/update_name
请求参数
milvus-UpdateInstanceName-parameters-entry-th-1">名称 | milvus-UpdateInstanceName-parameters-entry-th-2">类型 | milvus-UpdateInstanceName-parameters-entry-th-3">必填 | milvus-UpdateInstanceName-parameters-entry-th-4">描述 | milvus-UpdateInstanceName-parameters-entry-th-5">示例值 |
---|---|---|---|---|
ClusterName | string | 是 | 实例名称。 | milvus-test |
InstanceId | string | 是 | 实例 ID。 | c-123xxx |
返回参数
milvus-UpdateInstanceName-resultMapping-entry-th-1">名称 | milvus-UpdateInstanceName-resultMapping-entry-th-2">类型 | milvus-UpdateInstanceName-resultMapping-entry-th-3">描述 | milvus-UpdateInstanceName-resultMapping-entry-th-4">示例值 |
---|---|---|---|
object | |||
HttpStatusCode | integer | HTTP 请求状态码。 | 200 |
RequestId | string | 请求 ID。 | ABCD-1234-5678-EFGH |
Success | boolean | 请求是否成功。 | true |
ErrCode | string | 错误码。 | Instance.NotFound |
ErrMessage | string | 错误信息。 | Failed to find instance c-123xxx |
Data | boolean | 返回数据。 | true |
AccessDeniedDetail | string | 权限校验失败详情。 | { "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": true,"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxxx\", \"EncodedDiagnosticMessage\": \"xxxx\", \"AuthPrincipalType\": \"SubUser\", \"AuthPrincipalDisplayName\": \"xxxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"milvus:xxxx\" }"
}