ListInstances-阿里云帮助中心

Retrieves a list of Milvus instances in the current account.

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:ListInstances

list

*All Resource

*

None

Request syntax

POST /webapi/order/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterName	string	No	The instance name.	milvus-test
ClusterId	string	No	The instance ID.	c-123xxx
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The page size.	10
RegionId	string	No	The region ID.	cn-beijing
ResourceGroupId	string	No	The resource group ID.	rg-123xxx
Tag	array<object>	No	The tags used to filter instances.
	object	No	A tag object.
Key	string	No	The tag key.	key1
Value	string	No	The tag value.	value1

Response elements

Element	Type	Description	Example
	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	array<object>	An array of instance objects.
	array<object>
InstanceId	string	The instance ID.	c-123xxx
BeginTime	integer	The creation time of the instance.	1718608505000
RunningTime	integer	The duration the instance has been running.	536611
ExpireTime	integer	The expiration time of the instance.	1721232000000
RegionId	string	The region ID.	cn-beijing
ZoneId	string	The zone ID.	cn-beijing-g
InstanceStatus	string	The instance status. Valid values: `creating`: The instance is being created. `running`: The instance is running. `updating`: The instance is being updated. This includes scaling the instance, changing configurations, or modifying public network access. `disable`: The instance is unavailable because it has expired and requires renewal. `deleting`: The instance is being deleted. `deleted`: The instance has been deleted.	running
ClusterName	string	The instance name.	milvus-test
PackageType	string	The instance edition. Valid values: `trial`: Trial Edition. `standard`: Standard Edition.	trial
ClusterInfo	object	The instance details.
MilvusResourceInfoList	array<object>	A list of resource details for the instance's components.
	object
ComponentType	string	The component type. Valid values: `standalone` `proxy` `mix_coordinator` `query` `index` `data`	standalone
CuNum	integer	The number of CUs.	16
Replica	integer	The number of replicas.	1
DiskSize	integer	The disk size in GB.	100
DiskType	string	The disk type.	essd
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 proxy port.	19530
AttuPort	integer	The Attu port.	3000
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 public network access is enabled.	true
PayType	integer	The billing method. Valid values: `0`: pay-as-you-go. `1`: subscription.	1
ProductCode	string	The product code.	milvus_milvuspre_public_cn
ResourceGroupId	string	The resource group ID.	rg-123xxx
NodeType	string	The node type.	perf
AutoBackup	boolean	Indicates whether automatic backup is enabled.	true
Tags	array<object>	The tags attached to the instance.
	object	A key-value pair that represents a tag.
Key	string	The tag key.	key1
Value	string	The tag value.	value1
Version	string	The instance version.
TemplateVersion	string	The template version.
Total	integer	The total number of instances found.	15
AccessDeniedDetail	string	Details for an access denial error.	{ "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": 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",
      "NodeType": "perf",
      "AutoBackup": true,
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Version": "",
      "TemplateVersion": ""
    }
  ],
  "Total": 15,
  "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.