ListLeaderInstances - Hologres - Alibaba Cloud Documentation Center

Retrieves a list of potential leader instances.

Operation description

Request

This API retrieves a list of leader instances that are associated with a specific Holo instance.
The instanceId parameter is optional. If omitted, the API returns all related instances by default.
This API applies to Hologres AI nodes. Some parameters may be invalid for non-AI nodes.
Before you call this operation, review the billing and pricing of Alibaba Cloud Hologres.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/v1/instances/{instanceId}/primaryInstances HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	hgprecn-cn-zxu3001jn00d

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	5600196E-78E2-50F2-B2A1-C44D3B665438
InstanceList	array<object>	The list of instances.
	array<object>	Contains the details of an instance.
ChargeType	string	The billing method. Valid values: PostPaid : pay-as-you-go PrePaid : subscription	PostPaid
CommodityCode	string	The commodity code.	hologram_combo_public_cn
CreationTime	string	The creation time.	2022-07-25T02:15:35Z
ExpirationTime	string	The expiration time. This parameter is not returned for pay-as-you-go instances.	2022-07-25T02:15:35Z
InstanceId	string	The instance ID.	hgpostcn-cn-tl32vsdir00h
InstanceName	string	The instance name.	user_defined_name
InstanceStatus	string	The instance status. Valid values: Creating : The instance is being created. Running : The instance is running. Suspended : The instance is suspended. Allocating : The instance is being allocated. Some operations may be unavailable.	Running
InstanceType	string	The instance type. Valid values: Follower : follower instance Standard : Standard	Standard
Tags	array<object>	The list of tags.
	object	A tag object.
Key	string	The key of the tag.	tagKey
Value	string	The value of the tag.	value
BindingCode	string	Indicates the compatibility between the leader instance and the follower instance. A value of `0` indicates a perfect match. Any other value indicates a mismatch.	0
Success	string	Indicates whether the request was successfully processed. This does not reflect the business outcome of the operation. Valid values: true : Successful false : Failed	true
ErrorCode	string	The error code.	404
ErrorMessage	string	The error message.	Internal server error.
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "5600196E-78E2-50F2-B2A1-C44D3B665438",
  "InstanceList": [
    {
      "ChargeType": "PostPaid",
      "CommodityCode": "hologram_combo_public_cn",
      "CreationTime": "2022-07-25T02:15:35Z",
      "ExpirationTime": "2022-07-25T02:15:35Z",
      "InstanceId": "hgpostcn-cn-tl32vsdir00h",
      "InstanceName": "user_defined_name",
      "InstanceStatus": "Running",
      "InstanceType": "Standard",
      "Tags": [
        {
          "Key": "tagKey",
          "Value": "value"
        }
      ],
      "BindingCode": "0"
    }
  ],
  "Success": "true",
  "ErrorCode": "404",
  "ErrorMessage": "Internal server error.",
  "HttpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.