DescribeMasterSlaveServerGroups API reference - Server Load Balancer

Queries primary/secondary server groups.

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

slb:DescribeMasterSlaveServerGroups

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the CLB instance.	cn-hangzhou
LoadBalancerId	string	Yes	The CLB instance ID.	lb-bp14zi0n66zpg6o******
IncludeListener	boolean	No	Specifies whether to return information about the associated listeners. Valid values: true false	false
Tag	array<object>	No	The tags.
	object	No		[{"Key":"TestKey","Value":"TestValue"}]
Key	string	No	The key of tag N. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length, and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.	TestKey
Value	string	No	The value of tag N. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` and `acs:`.	TestValue
Description	string	No	The description of the primary/secondary server group.	Group3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
MasterSlaveServerGroups	object
MasterSlaveServerGroup	array<object>	The primary/secondary server groups.
	array<object>
MasterSlaveServerGroupId	string	The ID of the primary/secondary server group.	rsp-0bfuc******
MasterSlaveServerGroupName	string	The name of the primary/secondary server group.	Group3
AssociatedObjects	object	The associated resources.
Listeners	object
Listener	array<object>	The listeners.
	object
Port	integer	The listener port.	80
Protocol	string	The listener protocol.	tcp
CreateTime	string	The time when the CLB instance was created. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format.	2022-12-02T02:49:05Z
Tags	object
Tag	array<object>	The tags to add to the resource.
	object
TagKey	string	The tag key.	TestKey
TagValue	string	The tag value.	TestValue

Examples

Success response

JSON format

{
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "MasterSlaveServerGroups": {
    "MasterSlaveServerGroup": [
      {
        "MasterSlaveServerGroupId": "rsp-0bfuc******",
        "MasterSlaveServerGroupName": "Group3",
        "AssociatedObjects": {
          "Listeners": {
            "Listener": [
              {
                "Port": 80,
                "Protocol": "tcp"
              }
            ]
          }
        },
        "CreateTime": "2022-12-02T02:49:05Z",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.TagKey	The param of TagKey is missing.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.