All Products
Search
Document Center

Microservices Engine:AddGatewaySlb

Last Updated:Aug 12, 2024

Associates a Server Load Balancer (SLB) instance 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:AddGatewaySlb
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SlbIdstringYes

The ID of the SLB instance.

lb-bp18t6jjskwxh6wy1****
TypestringNo

The type of the service source. Valid values:

  • PUB_NET: Internet
  • PRIVATE_NET: VPC
PUB_NET
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-9cdcf8e4f58144059e73ff4c5ef9****
VServerGroupIdstringNo

The ID of the HTTP virtual service group.

353
ServiceWeightintegerNo

The service weight.

80
HttpPortintegerNo

The HTTP port number (virtual service group).

80
HttpsPortintegerNo

The HTTPS port number (virtual service group).

443
HttpsVServerGroupIdstringNo

The ID of the HTTPS virtual service group.

353
VServiceListarray<object>No

The SLB monitoring information.

objectNo
VServerGroupIdstringNo

The ID of the virtual server group.

rsp-bp1j**t0fyl**
VServerGroupNamestringNo

The name of the virtual server group.

k8s/31**0/***/istio-system/clusterid
PortintegerNo

The port number.

443
ProtocolstringNo

The protocol type. Valid values:

  • HTTP
  • HTTPS
HTTPS
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

316F5F64-F73D-42DC-8632-01E308B6****
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

  • If the request is successful, a success message is returned.
  • If the request fails, an error message is returned.
The request is successfully processed.
Codeinteger

The response code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Datastring

The data returned.

lb-uf6dqr4ondqi5w3df7hdf

Examples

Sample success responses

JSONformat

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": "lb-uf6dqr4ondqi5w3df7hdf"
}

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-05-10The request parameters of the API has changedView Change Details
2022-09-01The request parameters of the API has changedView Change Details