All Products
Search
Document Center

Enterprise Distributed Application Service:CreateK8sService

Last Updated:Jan 08, 2024

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

Request syntax

POST /pop/v5/k8s/acs/k8s_service

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The application ID.

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

The name of the Kubernetes Service.

service-http
TypestringYes

The type of the Kubernetes Service. Set the value to ClusterIP.

ClusterIP
ServicePortsstringYes

The port mapping of the Kubernetes Service. Set this parameter to a JSON array. The following parameters are included in the configurations:

  • protocol: the protocol used by the Service. Valid values: TCP and UDP. This parameter is mandatory.
  • port: the frontend service port. Valid values: 1 to 65535. This parameter is mandatory.
  • targetPort: the backend container port. Valid values: 1 to 65535. This parameter is mandatory.

Example: [{"protocol": "TCP", "port": 80, "targetPort": 8080},{"protocol": "TCP", "port": 81, "targetPort": 8081}]

[{"protocol":"TCP","port":80,"targetPort":8080}]
ExternalTrafficPolicystringNo

The policy used for external traffic management. Valid values:

  • Local: The network traffic can be routed to pods on the node where the Service is deployed.
  • Cluster: The network traffic can be routed to pods on other nodes in the cluster.

Default value: Local.

Local
Note
  • The nodePort value must be unique within a cluster.

  • When you configure multi-port mappings for a Kubernetes Service, you cannot map a service port to multiple container ports by using the same protocol.

Response parameters

ParameterTypeDescriptionExample
object

The returned content.

ChangeOrderIdstring

The change process ID.

b4b37bde-a125-****-****-741f7f4a9ae3
Codeinteger

The HTTP status code.

200
Messagestring

The additional information returned.

success
RequestIdstring

The request ID.

4823-bhjf-23u4-eiufh

Examples

Sample success responses

JSONformat

{
  "ChangeOrderId": "b4b37bde-a125-****-****-741f7f4a9ae3",
  "Code": 200,
  "Message": "success",
  "RequestId": "4823-bhjf-23u4-eiufh"
}

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.