All Products
Search
Document Center

:DescribeIngress

Last Updated:Dec 05, 2024

Call the DescribeIngress operation to query the details of an Ingress.

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:DescribeIngressget
*All Resources
*
    none
none

Request syntax

GET /pop/v1/sam/ingress/Ingress HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
IngressIdlongYes

The returned data.

87

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the SLB instance.

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

The ID of the namespace.

success
TraceIdstring

The name of the routing rule.

0a981dd515966966104121683d****
Dataobject

The port specified for the SLB listener.

SlbIdstring

The type of the SLB instance based on the IP address. Valid values:

  • internet: the Internet-facing SLB instance.
  • intranet: the internal-facing SLB instance.
lb-uf62****6d13tq2u5
NamespaceIdstring

The ID of the certificate.

cn-beijing:sae-test
Descriptionstring

The name of the routing rule.

ingress-sae-test
ListenerPortinteger

The default rule.

443
SlbTypestring

The container port of the application specified in the default rule.

internet
CertIdstring

The name of the application specified in the default rule.

13623****809_16cad216b32_845_-419427029
Namestring

The ID of the application specified in the default rule.

lb-uf6jt0nu4z6ior943****-80-f5****
DefaultRuleobject

The forwarding rules.

ContainerPortinteger

The name of the application specified in the forwarding rule.

8080
AppNamestring

The container port of the application specified in the forwarding rule.

app1
AppIdstring

The domain name of the application.

395b60e4-0550-458d-9c54-a265d036****
Rulesarray<object>

The ID of the application specified in the forwarding rule.

Ruleobject
AppNamestring

The path of the URL.

app1
ContainerPortinteger

The ID of the routing rule.

8080
Domainstring

The type of the SLB instance based on the processing capabilities. Valid values:

  • clb: the Classic Load Balancer (CLB) instance.
  • alb: the Application Load Balancer (ALB) instance.
edas.site
AppIdstring

The protocol used to forward requests. Valid values:

  • HTTP: used when the application needs to identify the transmitted data.
  • HTTPS: used when the application requires encrypted data transmission.
395b60e4-0550-458d-9c54-a265d036****
Pathstring

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.
/path1
Idlong

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.
87
LoadBalanceTypestring

Indicates whether the configurations of the routing rule were queried successfully. Valid values:

  • true: indicates that the query was successful.
  • false: indicates that the query failed.
clb

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "SlbId": "lb-uf62****6d13tq2u5",
    "NamespaceId": "cn-beijing:sae-test",
    "Description": "ingress-sae-test",
    "ListenerPort": 443,
    "SlbType": "internet",
    "CertId": "13623****809_16cad216b32_845_-419427029",
    "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
    "DefaultRule": {
      "ContainerPort": 8080,
      "AppName": "app1",
      "AppId": "395b60e4-0550-458d-9c54-a265d036****",
      "BackendProtocol": "HTTP"
    },
    "Rules": [
      {
        "AppName": "app1",
        "ContainerPort": 8080,
        "Domain": "edas.site",
        "AppId": "395b60e4-0550-458d-9c54-a265d036****",
        "Path": "/path1",
        "BackendProtocol": "HTTP",
        "RewritePath": ""
      }
    ],
    "Id": 87,
    "LoadBalanceType": "clb",
    "ListenerProtocol": "HTTP",
    "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
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-11-06The Error code has changed. The response structure of the API has changedView Change Details
2024-10-29The Error code has changed. The response structure of the API has changedView Change Details
2024-09-11The Error code has changed. The response structure of the API has changedView Change Details
2024-08-21The Error code has changed. The response structure of the API has changedView Change Details
2023-05-08The Error code has changed. The response structure of the API has changedView Change Details