tencent cloud

All product documents
APIs
DocumentationAPIsTencent Kubernetes EngineCluster APIsModifyClusterEndpointSP
ModifyClusterEndpointSP
Last updated: 2024-11-14 14:50:28
ModifyClusterEndpointSP
Last updated: 2024-11-14 14:50:28

1. API Description

Domain name for API request: tke.tencentcloudapi.com.

Modify the security policy of the external port of the managed cluster (the old way, only the external port of the managed cluster is supported)

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyClusterEndpointSP.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
SecurityPolicies.N No Array of String Security policy opens single IP or CIDR block to the Internet (for example: '192.168.1.0/24', with 'reject all' as the default).
SecurityGroup No String Modify public network security group

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying the security policy for the public network port of a managed cluster

This example shows you how to modify the security policy for the public network port of a managed cluster.

Input Example

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyClusterEndpointSP
<Common request parameters>

{
    "SecurityPolicies": [
        "192.168.1.0/24"
    ],
    "ClusterId": "cls-7ph3twqe"
}

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.KubernetesGetOperationError
FailedOperation.LbCommon An unknown error occurs while calling the underlying CLB.
FailedOperation.VPCUnexpectedError Unknown VPC error.
InternalError Internal error.
InternalError.CamNoAuth You do not have permissions.
InternalError.ClusterNotFound Cluster not found.
InternalError.Db DB error.
InternalError.Param Parameter error.
InternalError.UnexceptedInternal Internal error.
InternalError.UnexpectedInternal Unknown internal error.
InternalError.VPCUnexpectedError Unknown VPC error
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
LimitExceeded Quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon