All Products
Search
Document Center

Server Load Balancer:DescribeMasterSlaveServerGroups

Last Updated:Mar 14, 2024

Queries primary/secondary server groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
slb:DescribeMasterSlaveServerGroupsREAD
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the CLB instance.

cn-hangzhou
LoadBalancerIdstringYes

The CLB instance ID.

lb-bp14zi0n66zpg6o******
IncludeListenerbooleanNo

Specifies whether to return information about the associated listeners. Valid values:

  • true
  • false
false
Tagobject []No

The tags.

KeystringNo

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
ValuestringNo

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

value
DescriptionstringNo

The description of the primary/secondary server group.

test-112

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
MasterSlaveServerGroupsobject []

The primary/secondary server groups.

MasterSlaveServerGroupIdstring

The ID of the primary/secondary server group.

rsp-0bfuc******
MasterSlaveServerGroupNamestring

The name of the primary/secondary server group.

Group3
AssociatedObjectsobject

The associated resources.

Listenersobject []

The listeners.

Portinteger

The listener port.

80
Protocolstring

The listener protocol.

tcp
CreateTimestring

The time when the CLB instance was created. Specify the time in the YYYY-MM-DDThh:mm:ssZ format.

2022-12-02T02:49:05Z
Tagsobject []

The tags to add to the resource.

TagKeystring

The tag key.

test_slb_yaochi_tag_key-0
TagValuestring

The tag value.

000098dab00323fb

Examples

Sample success responses

JSONformat

{
  "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": "test_slb_yaochi_tag_key-0",
              "TagValue": "000098dab00323fb"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400MissingParam.TagKeyThe param of TagKey is missing.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-25The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Description
2023-07-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400