All Products
Search
Document Center

Microservices Engine:ListGatewaySlb

Last Updated:Feb 29, 2024

Queries the Server Load Balancer (SLB) instances that are associated with a gateway.

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
mse:ListGatewaySlbRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-1cef5440bf2d484db419fb264d4f****
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

RequestIdstring

The ID of the request.

EAB345F4-3AC3-560C-B653-65717703****
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

The request is successfully processed.
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Dataobject []

The data entries returned.

Idstring

The ID.

ID
SlbIdstring

The ID of the SLB instance.

lb-bp1kmnli3hdpreptw2ah3
SlbIpstring

The IP address of the SLB instance.

121.199.XX.XX
SlbPortstring

The port number of the SLB instance.

80,443
Typestring

The type.

PUB_NET
GatewayIdstring

The ID of the gateway.

1
GmtCreatestring

The creation time.

2022-01-14 14:39:16
GatewaySlbModestring

The mode of the SLB instance.

UserSelect
GatewaySlbStatusstring

The association status.

Ready
StatusDescstring

The description of the status.

Associating
VServerGroupIdstring

The ID of the HTTP virtual service group.

353
HttpPortinteger

The port number of the HTTP virtual service group.

80
HttpsPortinteger

The port number of the HTTPS virtual service group.

443
ServiceWeightinteger

The service weight.

80
EditEnableboolean

Indicates whether the edit operation is supported.

false
HttpsVServerGroupIdstring

The ID of the HTTPS virtual service group.

353

Examples

Sample success responses

JSONformat

{
  "RequestId": "EAB345F4-3AC3-560C-B653-65717703****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": "ID",
      "SlbId": "lb-bp1kmnli3hdpreptw2ah3",
      "SlbIp": "121.199.XX.XX",
      "SlbPort": "80,443",
      "Type": "PUB_NET",
      "GatewayId": "1",
      "GmtCreate": "2022-01-14 14:39:16",
      "GatewaySlbMode": "UserSelect",
      "GatewaySlbStatus": "Ready",
      "StatusDesc": "Associating\n",
      "VServerGroupId": "353",
      "HttpPort": 80,
      "HttpsPort": 443,
      "ServiceWeight": 80,
      "EditEnable": false,
      "HttpsVServerGroupId": "353",
      "VsMetaInfo": "",
      "VServiceList": [
        {
          "Port": "",
          "Protocol": "",
          "VServerGroupId": "",
          "VServerGroupName": ""
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2023-10-11The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-05-10The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-09-01The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.