ListFollowerInstances - Hologres - Alibaba Cloud Documentation Center

Retrieves the read-only secondary instances of a specified Hologres primary instance.

Operation description

Retrieves the list of read-only secondary instances associated with a specified Hologres primary instance. instanceId is a path parameter and must be provided when you call 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:ListFollowerInstances

list

*Instance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID. This parameter is located in the request path and must be provided when you call this operation.	hgprecn-cn-xxxxxxx

Request parameters

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

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
InstanceList	array<object>	The instance details.
	array<object>	The instance details.
InstanceId	string	The instance ID.	hgpostcn-cn-aaab9ad2d8fb
InstanceName	string	The instance name.	test_instance
CommodityCode	string	The commodity code, which is the same as the product detail code in User Center.	hologram_postpay_public_cn
InstanceStatus	string	The instance status.	Running
ChargeType	string	The billing method.	PostPaid
CreationTime	string	The time when the instance was created. The time is in the ISO 8601 standard in UTC.	2022-12-16T02:24:05Z
ExpirationTime	string	The time when the instance expires. The time is in the ISO 8601 standard in UTC.	2023-05-04T16:00:00.000Z
InstanceType	string	The instance type.	Standard
Tags	array<object>	The tag details.
	object	The tag details.
Key	string	The tag key.	tag
Value	string	The tag value.	value
Success	string	The request result, which indicates whether the request was successful. This parameter is not related to business logic.	true
ErrorCode	string	The error code.	null
ErrorMessage	string	The error message.	null
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "InstanceList": [
    {
      "InstanceId": "hgpostcn-cn-aaab9ad2d8fb",
      "InstanceName": "test_instance",
      "CommodityCode": "hologram_postpay_public_cn",
      "InstanceStatus": "Running",
      "ChargeType": "PostPaid",
      "CreationTime": "2022-12-16T02:24:05Z",
      "ExpirationTime": "2023-05-04T16:00:00.000Z",
      "InstanceType": "Standard",
      "Tags": [
        {
          "Key": "tag",
          "Value": "value"
        }
      ]
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.