All Products
Search
Document Center

:BindSlb

Last Updated:Nov 01, 2024

Associates a Server Load Balancer (SLB) instance with an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
sae:BindSlbcreate
  • All Resources
    *
    none
none

Request syntax

POST /pop/v1/sam/app/slb HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

0099b7be-5f5b-4512-a7fc-56049ef1****

0099b7be-5f5b-4512-a7fc-56049ef1****
InternetstringNo

[{"port":80,"targetPort":8080,"protocol":"TCP"}]

[{"port":80,"targetPort":8080,"protocol":"TCP"}]
IntranetstringNo

[{"port":80,"targetPort":8080,"protocol":"TCP"}]

[{"port":80,"targetPort":8080,"protocol":"TCP"}]
InternetSlbIdstringNo

lb-bp1tg0k6d9nqaw7l1****

lb-bp1tg0k6d9nqaw7l1****
IntranetSlbIdstringNo

lb-bp1tg0k6d9nqaw7l1****

lb-bp1tg0k6d9nqaw7l1****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The returned message.

success
TraceIdstring

The ID of the trace. It can be used to query the details of a request.

0a98a02315955564772843261e****
Dataobject

The returned data.

ChangeOrderIdstring

The ID of the change order. It can be used to query the task status.

01db03d3-3ee9-48b3-b3d0-dfce2d88****
ErrorCodestring

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request was invalid.
  • 5xx: indicates that a server error occurred.
200
Successboolean

Indicates whether the SLB instance was successfully associated with the application. Valid values:

  • true: The SLB instance was successfully associated with the application.
  • false: The SLB instance could not be associated with the application.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ChangeOrderId": "01db03d3-3ee9-48b3-b3d0-dfce2d88****"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400Slb.NotFoundThe SLB instance does not exist: slbId [%s]-
400InvalidApplication.NotFoundThe current application does not exist.-
400InvalidParameter.NotEmptyYou must specify the parameter %s.-
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.-
400SlbHttpsCert.NotConsistentThe HTTPS listening certificate for each listener must match.-
400SlbHttpsCert.NotFoundYou must configure the certificate before you configure HTTPS listening for the SLB instance.-
400SlbListenerPort.NotAvailableThe SLB listening port is unavailable: slbId [%s], port [%s]-
400SlbListenerType.InvalidAn SLB listener type error occurred. Only HTTPS and TCP are supported.-
400SlbSpec.NotSupportShared performance SLB instances are not supported.-
400SlbType.InvalidAn SLB network type error occurred.-
400SSLCert.NotFoundThe specified SSL certificate cannot be found.-
400System.UpgradingThe system is being upgraded. Please try again later.-
400Application.ChangerOrderRunningAn application change process is in progress. Please try again later.An application change process is in progress. Please try again later.
400Application.InvalidStatusThe application status is abnormal. Please try again later.The application status is abnormal. Please try again later.
400Application.NotDeployYetThe application has not been deployed. Please deploy it and try again.The application has not been deployed. Please deploy it and try again.
400InvalidParam.ProtocolNotSupportOnly TCP protocol is supported.Only TCP protocol is supported.
400SLBInstanceQuota.OverQuotaThe total number of SLB instances exceeds the quota. Please reduce the instances and try again.The total number of SLB instances exceeds the quota. Please reduce the instances and try again.
400Slb.Tag.Not.QualifiedThe current SLB instance cannot be reused because it may have been occupied by %s.The current SLB instance cannot be reused because it may have been occupied by %s.
400Application.NoInstanceAvailableNo instance is available for the application. Please scale out and try again.No instance is available for the application. Please scale out and try again.
400SlbAppVSwitch.NotMatchThe SLB instance does not match the vSwitch of the current application.The specified vSwitch does not exist. Please change the vSwitch.
404InvalidAppId.NotFoundThe specified AppId does not exist.-

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

Change history

Change timeSummary of changesOperation
2024-08-07The Error code has changed. The request parameters of the API has changedView Change Details
2022-02-25The Error code has changedView Change Details