CreateVpcEndPointService

Last updated: 2021-07-06 16:37:59

1. API Description

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

This API is used to create an endpoint service.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateVpcEndPointService.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
VpcId Yes String VPC instance ID
EndPointServiceName Yes String Endpoint service name
AutoAcceptFlag Yes Boolean Whether to automatically accept
ServiceInstanceId Yes String Real server ID, such as lb-xxx.
IsPassService No Boolean Whether it is of the type PassService. Valid values: true: yes; false: no. Default value: false

3. Output Parameters

Parameter Name Type Description
EndPointService EndPointService Endpoint service details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an endpoint service

Input Example

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

{
    "AutoAcceptFlag": true,
    "EndPointServiceName": "Test",
    "VpcId": "vpce-h0fk8lfc",
    "IsPassService": true,
    "ServiceInstanceId": "lb-nswq8wkq"
}

Output Example

{
  "Response": {
    "RequestId": "b237f475-49b3-4b10-af8e-071e0a5c7d7a",
    "EndPointService": {
      "VpcId": "vpc-hj3he929",
      "AutoAcceptFlag": "false",
      "ServiceInstanceId": "lb-nswq8wkq",
      "ServiceName": "test_002",
      "EndPointServiceId": "vpcsvc-kngiybxl",
      "ServiceVip": "10.101.1.11",
      "CreateTime": "0000-00-00 00:00:00",
      "ServiceOwner": "1254277469",
      "EndPointCount": 1,
      "EndPointSet": []
    }
  }
}

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
InvalidParameterValue.Empty Missing parameters.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
LimitExceeded Quota limit is reached.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.VpcMismatch The resources are not in the same VPC.