调用GetInstance API获取实例详情-向量检索服务 Milvus 版-阿里云-向量检索服务 Milvus 版(Milvus)-阿里云帮助中心

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

milvus:GetInstance

get

*Instance

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

无

请求语法

GET /webapi/instance/get HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域	cn-beijing
instanceId	string	是	实例 ID	c-xxxx

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求唯一号	ABCD-1234-5678-EFGH
success	boolean	请求是否成功	true
instance	InstanceDetail	实例详情

示例

正常返回示例

JSON格式

{
  "RequestId": "ABCD-1234-5678-EFGH",
  "success": true,
  "instance": {
    "instanceName": "milvus-test",
    "instanceId": "c-xxx",
    "regionId": "cn-beijing",
    "zoneId": "cn-hangzhou-i",
    "status": "running",
    "paymentType": "PayAsYouGo",
    "resourceGroupId": "rg-aek3dcgyq7pnqwa",
    "vpcId": "vpc-xxx",
    "createTime": "2025-04-27T02:04:25Z",
    "runningTime": 1,
    "expireTime": "2025-04-27T02:04:25Z\n",
    "dbVersion": "2.5",
    "orderId": "4751",
    "autoBackup": true,
    "configuration": "rootCoord:\n    maxDatabaseNum: 64 # Maximum number of database\n    maxPartitionNum: 4096 ",
    "ha": true,
    "multiZoneMode": "Single",
    "encrypted": false,
    "kmsKeyId": "key-xxx",
    "vSwitchIds": [
      {
        "zoneId": "cn-hangzhou-i",
        "vswId": "vsw-xxx"
      }
    ],
    "securityGroupIds": [
      "sg-xxx"
    ],
    "tags": [
      {
        "key": "k1",
        "value": "v1"
      }
    ],
    "components": [
      {
        "type": "data",
        "replica": 1,
        "cuNum": 4,
        "cuType": "general",
        "diskSizeType": "Normal"
      }
    ]
  }
}

错误码

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

变更历史

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