ListLeaderInstances - Hologres - Alibaba Cloud Documentation Center

Retrieves the list of possible primary instance IDs.

Operation description

Retrieves the list of primary instances that can be associated with a specified Hologres secondary instance. instanceId is a path parameter and must be provided when calling this operation.

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

hologram:ListLeaderInstances

list

*Instance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID. This parameter is in the request path and must be provided when you invoke this operation.	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	Id of the request	5600196E-78E2-50F2-B2A1-C44D3B665438
InstanceList	array<object>	The instance list.
	array<object>	The role list.
ChargeType	string	The billing type. Valid values: PostPaid : Subscription. PrePaid : Pay-as-you-go.	PostPaid
CommodityCode	string	The commodity code.	hologram_combo_public_cn
CreationTime	string	The creation time in UTC in ISO 8601 format.	2022-07-25T02:15:35Z
ExpirationTime	string	The expiration time in UTC in ISO 8601 format. Pay-as-you-go instances do not have an expiration time.	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 : Being created. Running : Running normally. Suspended : Suspended. Allocating : Being processed. Some operations may not be allowed.	Running
InstanceType	string	The instance type. Valid values: Follower : Read-only secondary instance. Standard : Standard.	Standard
Tags	array<object>	The tag list.
	object	The tag list.
Key	string	The tag key.	tagKey
Value	string	The tag value.	value
BindingCode	string	The compatibility level between the primary instance and the secondary instance. A value of 0 indicates a perfect match. Other values indicate a mismatch.	0
Success	string	Indicates whether the request was successful. This is unrelated to business logic. Valid values: true : Succeeded. 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.