All Products
Search
Document Center

Enterprise Distributed Application Service:GetK8sServices

Last Updated:Jan 08, 2024

Queries application services that are deployed in a Kubernetes cluster.

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:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

GET /pop/v5/k8s/acs/k8s_service

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

5a166fbd-****-****-a286-781659d9f54c

Response parameters

ParameterTypeDescriptionExample
object

The content that is returned.

Codeinteger

The ID of the change process.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

4823-bhjf-23u4-eiufh
Servicesobject []

The list of services in the Kubernetes cluster.

Typestring

The type of the service.

ClusterIP
Namestring

The name of the service.

service-http
ClusterIPstring

The IP address of the service in the Kubernetes cluster.

104.23.xx.xx
ServicePortsobject []

The mapping of service ports.

TargetPortstring

The backend container port.

8080
NodePortinteger

The port of the node.

0
Portinteger

The frontend service port.

80
Protocolstring

The protocol of the service.

TCP

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "4823-bhjf-23u4-eiufh",
  "Services": [
    {
      "Type": "ClusterIP",
      "Name": "service-http",
      "ClusterIP": "104.23.xx.xx",
      "ServicePorts": [
        {
          "TargetPort": "8080",
          "NodePort": 0,
          "Port": 80,
          "Protocol": "TCP"
        }
      ]
    }
  ]
}

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.