文档中心

向量数据库 Milvus 版

Serverless

MSDescribeInstance - Serverless 实例详情

调用 MSDescribeInstance 查询 Serverless 实例详情。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	MSDescribeInstance	要执行的操作，取值：MSDescribeInstance。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	s-dev-12345678	实例 ID。
InstanceName	String	否	milvus-serverless-instance	实例名称。
ProjectName	String	否	default	所属项目。
PageNumber	Integer	否	1	页码，默认为 1。
PageSize	Integer	否	10	每页展示数量，默认为 10。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AccountId	String	-	账户 ID。
InstanceId	String	-	实例 ID。
InstanceName	String	-	实例名称。
InstanceVersion	String	-	实例版本。
Region	String	-	所属区域。
ProjectName	String	-	项目名称。
Status	String	-	实例状态。
Username	String	-	用户名。
DatabaseName	String	-	数据库名。
CreateTime	String	-	创建时间。
UpdateTime	String	-	更新时间。
DeleteProtectEnabled	Boolean	-	是否开启删除保护。
Tags	Array of Object	-	标签列表。
NetworkConfig	Object	-	网络配置。
ChargeConfig	Object	-	计费配置。
EndpointList	Array of Object	-	接入点列表。

请求示例

POST /?Action=MSDescribeInstance&Version=2023-01-01 HTTP/1.1​
Host: /​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260316T070008Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260316/cn-beijing/milvus/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "s-dev-12345678"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "202603161500110060040232337C2E38",​
    "Action": "MSDescribeInstance",​
    "Version": "2023-01-01",​
    "Service": "milvus",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "AccountId": "FubYuNem",​
    "InstanceId": "dkU1",​
    "InstanceName": "WCIJca1Z3S",​
    "InstanceVersion": "aDol",​
    "Region": "uAhzd",​
    "ProjectName": "bpybBzFb6Mo",​
    "Status": "6S",​
    "Username": "s0t7",​
    "DatabaseName": "j8vG3",​
    "CreateTime": "fxJMbXjva7m",​
    "UpdateTime": "EQXWxw",​
    "DeleteProtectEnabled": false,​
    "Tags": [​
      {​
        "Key": "2je9",​
        "Value": "GscxM8u",​
        "SystemTag": false​
      }​
    ],​
    "NetworkConfig": {​
      "VpcInfo": {​
        "VpcId": "82QhFma",​
        "VpcName": "InKPw4"​
      },​
      "SubnetInfo": {​
        "SubnetId": "BMxJ",​
        "SubnetName": "X8v"​
      },​
      "InnerEndpointEnabled": true,​
      "HttpsEnabled": false,​
      "IpVersion": "B5JMQ"​
    },​
    "ChargeConfig": {​
      "ChargeType": "sPZDEeb",​
      "Period": 880,​
      "AutoRenew": true,​
      "ExpireDate": "Hg6me7j"​
    },​
    "EndpointList": [​
      {​
        "Type": "bNBgj8qK",​
        "Domain": "0WBRLmSv",​
        "Ip": "tV1T0r1ukj",​
        "PrivateDomainPublishEnabled": true,​
        "AllowGroupList": [​
          {​
            "GroupName": "wpEK5qfWM5d",​
            "List": [​
              "0GRT78"​
            ]​
          }​
        ],​
        "Eip": "lvQGfQ",​
        "EipId": "xI0T74x3t",​
        "AllowList": [​
          "Rq"​
        ]​
      }​
    ]​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	AccountNoPermission	accountId have no permission	当前账号没有权限。

最近更新时间：2026.04.28 16:35:29

这个页面对您有帮助吗？

有用

无用