tencent cloud

All product documents
Tencent Cloud Elastic Microservice
DocumentationTencent Cloud Elastic MicroserviceAPI DocumentationAccess Policy APIsCreateApplicationService
CreateApplicationService
Download PDF
Last updated: 2023-12-04 16:38:21
CreateApplicationService
Last updated: 2023-12-04 16:38:21
Download PDF

1. API Description

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

This API is used to create 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: CreateApplicationService.
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 ServicePortMapping Details of the access policy

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 Adding an access policy

Input Example

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

{
    "SourceChannel": 0,
    "ApplicationId": "xx",
    "Service": {
        "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
        ]
    },
    "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.
InternalError.DescribeServiceListError Failed to query the service list
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.ApplicationAccessServiceReachMaximum Reached the upper limit of access policies for this application.
InvalidParameterValue.ApplicationServiceAlreadyExist The access policy name already exists.
InvalidParameterValue.ApplicationServiceNotFound The access policy does not exist.
InvalidParameterValue.CannotOverWriteOtherApplicationService The access mode of other applications cannot be overwritten.
InvalidParameterValue.CannotUpdateServiceByBothMethods Full update and single-entry update cannot be specified at the same time.
InvalidParameterValue.InvalidEksServiceType The access type is not supported.
InvalidParameterValue.NamespaceNotBelongToAppid The namespace does not belong to the current account.
InvalidParameterValue.PortDuplicateError The application port mapping already exists.
InvalidParameterValue.PortIsReserved The application port is a reserved port.
InvalidParameterValue.TemIdInvalid The TEM ID is incorrect.
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.
UnsupportedOperation.UnsupportAction ACTION not supported
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