GetInstance - 获取实例详情

更新时间:

获取实例详情

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

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"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情