tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyApplicationService

Last updated: 2023-12-04 16:38:21

    1. API Description

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

    This API is used to modify an access policy.

    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: ModifyApplicationService.
    Version Yes String Common Params. The value used for this API: 2021-07-01.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ApplicationId Yes String Application ID
    EnvironmentId Yes String Environment ID
    SourceChannel No Integer Source channel. Please keep the default value.
    Service No EksService Full access mode settings
    Data No ServicePortMapping Single entry access mode settings

    3. Output Parameters

    Parameter Name Type Description
    Result Boolean Whether the action succeeded
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying an access policy

    Input Example

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

{
    "SourceChannel": 0,
    "ApplicationId": "xx",
    "Service": {
        "ApplicationName": "xx",
        "ExternalIp": "xx",
        "Name": "xx",
        "ApplicationId": "xx",
        "AllIpDone": true,
        "PortMappings": [
            {
                "Protocol": "xx",
                "ServiceName": "xx",
                "TargetPort": 0,
                "Port": 0
            }
        ],
        "Yaml": "xx",
        "LoadBalanceId": "xx",
        "ServicePortMappingList": [
            {
                "ExternalIp": "xx",
                "VpcId": "xx",
                "PortMappingItemList": [
                    {
                        "Protocol": "xx",
                        "TargetPort": 0,
                        "Port": 0
                    }
                ],
                "Yaml": "xx",
                "LoadBalanceId": "xx",
                "ServiceName": "xx",
                "ClusterIp": "xx",
                "SubnetId": "xx",
                "Type": "xx",
                "Ports": [
                    0
                ]
            }
        ],
        "VersionName": "xx",
        "ClusterIp": [
            "xx"
        ],
        "SubnetId": "xx",
        "Type": "xx",
        "Ports": [
            0
        ],
        "EnableRegistryNextDeploy": 0,
        "FlushAll": true
    },
    "EnvironmentId": "xx"
}

    Output Example

    {
    "Response": {
        "Result": true,
        "RequestId": "xx"
    }
}

    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
    InternalError.DefaultInternalError The server is busy. Retry later.
    InvalidParameter.ApplicationAccessServiceReachMaximum Reached the upper limit of access policies for this application.
    InvalidParameter.LBServiceCannotSupportTcpUdpSameTime For an LB application, TCP and UDP cannot be both supported..
    InvalidParameter.MustProvidePortMappingRules The PortMapping rule is required.
    InvalidParameter.ServiceNameNotValid The application name is invalid.
    InvalidParameter.ServiceUseReserveSuffix The suffix of the application name is not allowed.
    InvalidParameter.TooManyPortMappingRules Reached the upper limit of PortMapping rules.
    InvalidParameterValue.ApplicationServiceNotFound The access policy does not exist.
    InvalidParameterValue.InvalidEksServiceType The access type is not supported.
    InvalidParameterValue.PortIsReserved The application port is a reserved port.
    ResourceNotFound.ServiceNotFound The application is not found.
    ResourceNotFound.ServiceRunningVersionNotFound No running pod is found.
    ResourceNotFound.VersionNamespaceNotFound The environment corresponding to this version is not found.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy