All Products
Search
Document Center

:DescribeApplicationSlbs

Last Updated:Dec 05, 2024

Obtain the SLB configuration of 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:DescribeApplicationSlbsget
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the request.

017f39b8-dfa4-4e16-a84b-1dcee4b1****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The returned message.

  • success is returned when the request succeeds.
  • An error code is returned when the request fails.
91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

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

success
TraceIdstring

The returned data.

0a98a02315955564772843261e****
Dataobject

Configurations of internal-facing SLB instances.

Intranetarray<object>

The ID of the SSL certificate issued by Alibaba Cloud.

Intranetobject
HttpsCertIdstring

The supported protocol.

1513561019707729_16f37aae5f3_-375882821_-169099****
Protocolstring

The container port.

TCP
TargetPortinteger

The port specified for the SLB listener.

8080
Portinteger

The IP address of the Internet-facing SLB instance.

80
InternetIpstring

The ID of the Internet-facing SLB instance.

59.74.**.**
InternetSlbIdstring

Configurations of Internet-facing SLB instances.

lb-uf6xc7wybefehnv45****
Internetarray<object>

The ID of the SSL certificate issued by Alibaba Cloud.

Internetobject
HttpsCertIdstring

The supported protocol.

1513561019707729_16f37aae5f3_-375882821_-169099****
Protocolstring

The container port.

TCP
TargetPortinteger

The port specified for the SLB listener.

8080
Portinteger

The ID of the internal-facing SLB instance.

80
IntranetSlbIdstring

The IP address of the internal-facing SLB instance.

lb-uf6xc7wybefehnv45****
IntranetIpstring

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.
192.168.0.0
ErrorCodestring

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

Indicates whether the information about the SLB instances that are associated with an application was obtained successfully. Valid values:

  • true: indicates that the information was obtained successfully.
  • false: indicates that the information failed to be obtained.
200

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Intranet": [
      {
        "HttpsCertId": "1513561019707729_16f37aae5f3_-375882821_-169099****",
        "Protocol": "TCP",
        "TargetPort": 8080,
        "Port": 80
      }
    ],
    "InternetIp": "59.74.**.**",
    "InternetSlbId": "lb-uf6xc7wybefehnv45****",
    "Internet": [
      {
        "HttpsCertId": "1513561019707729_16f37aae5f3_-375882821_-169099****",
        "Protocol": "TCP",
        "TargetPort": 8080,
        "Port": 80
      }
    ],
    "IntranetSlbId": "lb-uf6xc7wybefehnv45****",
    "IntranetIp": "192.168.0.0",
    "InternetSlbExpired": true,
    "IntranetSlbExpired": true
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
400InvalidApplication.NotFoundThe current application does not exist.
400InvalidParameter.NotEmptyYou must specify the parameter %s.
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s

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 response structure of the API has changedView Change Details
2024-06-18The Error code has changed. The response structure of the API has changedView Change Details
2024-05-30The Error code has changed. The response structure of the API has changedView Change Details