All Products
Search
Document Center

Enterprise Distributed Application Service:UpdateK8sIngressRule

Last Updated:Jan 08, 2024

Updates an ingress.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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
edas:ManageClusterWrite
  • Cluster
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}
    none
none

Request syntax

PUT /pop/v5/k8s/acs/k8s_ingress

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringNo

The ID of the Kubernetes cluster.

5b2b4ab4-efbc-4a81-9c45-xxxxxxxxxxxxx
NamespacestringNo

The namespace of the Kubernetes cluster.

default
NamestringNo

The name of the Ingress. The name can contain lowercase letters, digits, and hyphens (-). It must start with a lowercase letter but cannot end with a hyphen (-). The name can be up to 63 characters in length.

my-ingress-rule
IngressConfstringNo

The routing rules of the Ingress. Set this parameter to a JSON string in the following format:

{
  "rules": [
    {
      "host": "abc.com",
      "secretName": "tls-secret",
      "paths": [
        {
          "path": "/path",
          "backend": {
            "servicePort": 80,
            "serviceName": "xxx"
          }
        }
      ]
    }
  ]
}

Parameter description:

  • rules: the list of routing rules.
  • host: the domain name to be accessed.
  • secretName: the name of the Secret that stores the information about the Transport Layer Security (TLS) certificate. The certificate is required if you need to use the HTTPS protocol.
  • paths: the list of paths to be accessed.
  • path: the path to be accessed.
  • backend: the configuration of the backend service. You can specify a service that is created in the Enterprise Distributed Application Service (EDAS) console.
  • serviceName: the name of the backend service.
  • servicePort: the port of the backend service.
{"rules":[{"host":"abc.com","secretName":"tls-secret","paths":[{"path":"/path","backend":{"servicePort":80,"serviceName":"xxx"}}]}]}
AnnotationsstringNo

The annotations.

{\"nginx.ingress.kubernetes.io/ssl-redirect\":\"true\",\"nginx.ingress.kubernetes.io/configuration-snippet\":\"set $test value\"}
LabelsstringNo

The labels.

{\"test-label\":\"test-label-value\"}

Response parameters

ParameterTypeDescriptionExample
object

The object that is returned.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The message that is returned.

success

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success"
}

Error codes

HTTP status codeError codeError messageDescription
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.No permissions

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

Change history

Change timeSummary of changesOperation
No change history