GetInstanceDetail-阿里云帮助中心

Retrieves the details of a specific instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

milvus:GetInstanceDetail

get

*Instance

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

None

Request syntax

POST /webapi/cluster/detail HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	c-123xxx

Response elements

Element	Type	Description	Example
	object	The response object.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	ABCD-1234-5678-EFGH
Success	boolean	Indicates whether the request was successful.	true
ErrCode	string	The error code.	Instance.NotFound
ErrMessage	string	The error message.	Failed to find instance c-123xxx
Data	object	The returned data.
InstanceId	string	The instance ID.	c-123xxx
BeginTime	integer	The creation time of the instance, represented as a Unix timestamp in milliseconds.	1716863508000
RunningTime	integer	The runtime of the instance, in milliseconds.	1743679
ExpireTime	integer	The expiration time of the instance, represented as a Unix timestamp in milliseconds.	1721664000000
RegionId	string	The ID of the region where the instance is located.	cn-beijing
ZoneId	string	The ID of the availability zone where the instance is located.	cn-beijing-g
InstanceStatus	string	The instance status. Possible values: `creating`: The instance is being created. `running`: The instance is running. `updating`: The instance is being updated. This can occur during operations such as cluster scaling, configuration changes, or enabling/disabling the public endpoint. `disable`: The instance is unavailable because it has expired. You must renew the instance to reactivate it. `deleting`: The instance is being deleted. `deleted`: The instance is deleted.	running
PackageType	string	The instance edition. Possible values: `trial`: Starter edition. `standard`: Standard edition.	standard
ClusterInfo	object	The instance details.
MilvusResourceInfoList	array<object>	A list of resource details for each component in the instance.
	object	A resource object for a component.
ComponentType	string	The component type. Possible values: `standalone` `proxy` `mix_coordinator` `query` `index` `data`	standalone
CuNum	integer	The number of CUs.	8
CuRatio	integer	The CU specification, which defines the ratio of CPU cores to memory. Possible values: `4`: 1 core to 4 GB of memory. `8`: 1 core to 8 GB of memory.	4
Replica	integer	The number of replicas.	2
DiskSize	integer	The disk size, in GB.	100
DiskType	string	The disk type.	essd
ZoneId	string	The ID of the availability zone for this component.
PayType	string	The billing method for this component.
IntranetUrl	string	The internal endpoint.	c-123xxx-internal.milvus.aliyuncs.com
InternetUrl	string	The public endpoint.	c-123xxx-.milvus.aliyuncs.com
TotalCuNum	integer	The total number of CUs.	24
TotalDiskSize	integer	The total disk size, in GB.	500
ProxyPort	integer	The port of the proxy component.	19530
AttuPort	integer	The port of the Attu component.	3000
OssStorageTimestamp	integer	The time the OSS storage metric was recorded, represented as a Unix timestamp in milliseconds.	1718604000000
OssStorageSize	string	The size of data stored in Object Storage Service (OSS), in GB.	125.15 GB
VpcId	string	The VPC ID.	vpc-123xxx
VswId	string	The vSwitch ID.	vsw-123xxx
SgId	string	The security group ID.	sg-123xxx
OpenPublicNet	boolean	Indicates whether the public endpoint is enabled.	true
ClusterName	string	The instance name.	aliyun-test
PayType	integer	The billing method. Possible values: `0`: Pay-as-you-go. `1`: Subscription.	1
BucketName	string	The OSS bucket name.	milvus-test
BucketPath	string	The path to the data within the OSS bucket.	https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx
Version	string	The Milvus version.	2.4
AclId	string	The ID of the access control list (ACL) for the public endpoint.	acl-123xxx
UserConfig	string	The custom configurations for the instance.	dataCoord:\n segment:\n maxSize: 1024
TemplateVersion	string	The software stack version.	2.4.1-1.0-0.0.1
ProductCode	string	The product code.	milvus_milvuspre_public_cn
ResourceGroupId	string	The resource group ID.	rg-123xxx
MeasureConfig	object	The resource allocation for each node type.
ProxyNodeCuNum	integer	The number of CUs for each proxy node.	4
IndexNodeCuNum	integer	The number of CUs for each index node.	4
QueryNodeCuNum	integer	The number of CUs for each query node.	4
DataNodeCuNum	integer	The number of CUs for each data node.	4
MixCoodinatorNodeCuNum	integer	The number of CUs for each mix-coordinator node.	4
IndexNodeReplica	integer	The number of replicas for index nodes.	2
QueryNodeReplica	integer	The number of replicas for query nodes.	2
DataNodeReplica	integer	The number of replicas for data nodes.	2
MixCoodinatorNodeReplica	integer	The number of replicas for mix-coordinator nodes.	2
ProxyNodeReplica	integer	The number of replicas for proxy nodes.	2
EnableHa	boolean	Indicates whether high availability (HA) is enabled.	true
NodeType	string	The node type. Possible values: `perf`: Compute-optimized. `cap`: Storage-optimized.	perf
Tags	array<object>	The tags that are attached to the instance.
	object	A tag object.
Key	string	The key of the tag.	key1
Value	string	The value of the tag.	value1
Encrypted	string	Indicates whether disk encryption with Key Management Service (KMS) is enabled.
KmsKeyId	string	The ID of the key from Key Management Service (KMS) used for disk encryption. This parameter is returned only when disk encryption is enabled.
MultiZoneMode	string	The deployment mode for a multi-zone instance. This parameter is returned only when high availability is enabled across multiple availability zones.
HighAvailability	object	Details about the high availability (HA) configuration.
Mode	string	The high availability mode. A common value is `Multi-zone`.
PrimaryZoneId	string	The ID of the primary availability zone in an HA setup.
SecondaryZoneId	string	The ID of the secondary availability zone in an HA setup.
CurrentActiveAZ	string	The availability zone that is currently active.
VSwitches	array<object>	A list of vSwitches associated with the instance, typically used in a multi-zone deployment.
	object	A vSwitch object.
VswId	string	The ID of the vSwitch.
ZoneId	string	The ID of the availability zone where the vSwitch is located.
MaintainablePeriod	string	The maintenance window for the instance. The format is `HH:mmZ-HH:mmZ`.
AccessDeniedDetail	string	The details about the access denial.	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }

Examples

Success response

JSON format

{
  "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,
          "CuRatio": 4,
          "Replica": 2,
          "DiskSize": 100,
          "DiskType": "essd",
          "ZoneId": "",
          "PayType": ""
        }
      ],
      "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": 4,
      "IndexNodeCuNum": 4,
      "QueryNodeCuNum": 4,
      "DataNodeCuNum": 4,
      "MixCoodinatorNodeCuNum": 4,
      "IndexNodeReplica": 2,
      "QueryNodeReplica": 2,
      "DataNodeReplica": 2,
      "MixCoodinatorNodeReplica": 2,
      "ProxyNodeReplica": 2
    },
    "EnableHa": true,
    "NodeType": "perf",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Encrypted": "",
    "KmsKeyId": "",
    "MultiZoneMode": "",
    "HighAvailability": {
      "Mode": "",
      "PrimaryZoneId": "",
      "SecondaryZoneId": "",
      "CurrentActiveAZ": ""
    },
    "VSwitches": [
      {
        "VswId": "",
        "ZoneId": ""
      }
    ],
    "MaintainablePeriod": ""
  },
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.