All Products
Search

This Product

    Server Load Balancer:DescribeRuleAttribute

    Document Center

    Server Load Balancer:DescribeRuleAttribute

    Last Updated:Oct 15, 2024

    Queries the configurations of a specified forwarding rule.

    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
    slb:DescribeRuleAttributeget
    • loadbalancer
      acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
    • slb:tag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region where the Server Load Balancer (SLB) instance is deployed.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    RuleIdstringYes

    The ID of the forwarding rule.

    		rule-bp1efemp9****

    Response parameters

    ParameterTypeDescriptionExample
    object
    VServerGroupIdstring

    The ID of the vServer group that is associated with the forwarding rule.

    		rsp-cige6j****
    Cookiestring

    The cookie to be configured on the backend server.

    The cookie must be 1 to 200 characters in length and can contain ASCII letters and digits. It cannot contain commas (,), semicolons (;), or whitespace characters. It cannot start with a dollar sign ($).

    If you set the StickySession parameter to on and the StickySessionType parameter to server, this parameter is required.

    		wwe
    LoadBalancerIdstring

    The ID of the SLB instance.

    		lb-bp1ca0zt07t934wxe****
    RuleIdstring

    The ID of the forwarding rule.

    		rule-hfgnd*****
    RequestIdstring

    The ID of the request.

    		9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
    HealthCheckConnectPortinteger

    The backend port that is used for health checks.

    Valid values: 1 to 65535.

    Note If you set the HealthCheck parameter to on, this parameter is required. If this parameter is empty but HealthCheck is set to on, the listener port is used for health checks.
    		23
    HealthCheckTimeoutinteger

    The timeout period of a health check response. If a backend ECS instance does not respond within the specified timeout period, the ECS instance fails the health check.

    Valid values: 1 to 300. Unit: seconds.

    Note If you set the HealthCheck parameter to on, this parameter is required.
    		34
    CookieTimeoutinteger

    The timeout period of a cookie.

    Valid values: 1 to 86400. Unit: seconds.

    Note If you set the StickySession parameter to on and the StickySessionType parameter to insert, this parameter is required.
    		12
    HealthCheckDomainstring

    The domain name that is used for health checks. Valid values:

    • $_ip: The private IP address of the backend server. If the $_ip parameter is set or the HealthCheckDomain parameter is not set, SLB uses the private IP addresses of backend servers as the domain names for health checks.
    • domain: The domain name must be 1 to 80 characters in length. It can contain only letters, digits, periods (.),and hyphens (-).
    Note If you set the HealthCheck parameter to on, this parameter is required.
    		www.example.com
    UnhealthyThresholdinteger

    The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy. In this case, the health check state is changed from success to fail.

    Valid values: 2 to 10.

    Note If you set the HealthCheck parameter to on, this parameter is required.
    		3
    HealthCheckHttpCodestring

    The HTTP status code that indicates a successful health check. Separate multiple HTTP status codes with commas (,). Default value: http_2xx.

    Valid values: http_2xx, http_3xx, http_4xx, and http_5xx.

    Note If you set the HealthCheck parameter to on, this parameter is required.
    		http_3xx
    Domainstring

    The domain name that is configured in the forwarding rule.

    		test.com
    ListenerPortstring

    The listener port that is used by the SLB instance.

    		90
    Urlstring

    The URL that is configured in the forwarding rule.

    		/cache
    HealthCheckIntervalinteger

    The time interval between two consecutive health checks.

    Valid values: 1 to 50. Unit: seconds.

    Note If you set the HealthCheck parameter to on, this parameter is required.
    		34
    HealthCheckURIstring

    The URI that is used for health checks.

    Note If you set the HealthCheck parameter to on, this parameter is required.
    		10.21.22.1
    RuleNamestring

    The name of the forwarding rule.

    		Rule1
    StickySessionTypestring

    The method that is used to handle a cookie. Valid values:

    • insert: inserts a cookie into the response. SLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response packet that is sent to a client. The next request from the client will contain this cookie, and the listener will distribute this request to the recorded backend server.
    • server: rewrites a cookie. When SLB detects a user-defined cookie, SLB overwrites the original cookie with the user-defined cookie. The next request from the client contains the user-defined cookie, and the listener distributes the request to the recorded backend server.
    Note If you set the StickySession parameter to on, this parameter is required.
    		insert
    Schedulerstring

    The scheduling algorithm. Valid values:

    • wrr (default): Backend servers that have higher weights receive more requests than backend servers that have lower weights.
    • rr: Requests are distributed to backend servers in sequence.
    Note If you set the ListenerSync parameter to off, this parameter is required. If you set the parameter to on, the configuration of the listener is used.
    		wrr
    ListenerSyncstring

    Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.

    Valid values: on and off.

    • off: does not use the configurations of the listener. You can customize health check and session persistence configurations for the forwarding rule.
    • on: uses the configurations of the listener.
    		off
    HealthyThresholdinteger

    The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy. In this case, the health check state is changed from fail to success.

    Valid values: 2 to 10.

    Note If you set the HealthCheck parameter to on, this parameter is required.
    		2
    StickySessionstring

    Indicates whether session persistence is enabled.

    Valid values: on and off.

    Note If you set the ListenerSync parameter to off, this parameter is required. If you set the parameter to on, the configuration of the listener is used.
    		off
    HealthCheckstring

    Specifies whether to enable health checks.

    Valid values: on and off.

    Note If you set the ListenerSync parameter to off, this parameter is required. If you set the parameter to on, the configuration of the listener is used.
    		off

    Examples

    Sample success responses

    JSONformat

    {
  "VServerGroupId": "rsp-cige6j****",
  "Cookie": "wwe",
  "LoadBalancerId": "lb-bp1ca0zt07t934wxe****",
  "RuleId": "rule-hfgnd*****",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "HealthCheckConnectPort": 23,
  "HealthCheckTimeout": 34,
  "CookieTimeout": 12,
  "HealthCheckDomain": "www.example.com",
  "UnhealthyThreshold": 3,
  "HealthCheckHttpCode": "http_3xx ",
  "Domain": "test.com",
  "ListenerPort": "90",
  "Url": "/cache",
  "HealthCheckInterval": 34,
  "HealthCheckURI": "10.21.22.1",
  "RuleName": "Rule1",
  "StickySessionType": "insert",
  "Scheduler": "wrr",
  "ListenerSync": "off",
  "HealthyThreshold": 2,
  "StickySession": "off",
  "HealthCheck": "off"
}

    Error codes

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