tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AddRealServers

Last updated: 2023-07-13 15:25:31

1. API Description

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

This API is used to add the information of the origin server (server), which supports IP or the domain name.

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: AddRealServers.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
ProjectId Yes Integer Project ID corresponding to origin server
RealServerIP.N Yes Array of String IP or domain name corresponding to origin server
RealServerName Yes String Name of the origin server
TagSet.N No Array of TagPair List of tags

3. Output Parameters

Parameter Name Type Description
RealServerSet Array of NewRealServer An information list of origin server
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding origin server

Input Example

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

{
    "ProjectId": "0",
    "RealServerName": "'test'",
    "RealServerIP": [
        "1.1.1.1"
    ]
}

Output Example

{
    "Response": {
        "RealServerSet": [
            {
                "RealServerId": "id-5dr8gu4",
                "RealServerIP": "1.1.1.1"
            }
        ],
        "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
    }
}

Example2 AddRealServers

Input Example

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

{
    "ProjectId": "0",
    "RealServerName": "benny",
    "RealServerIP": [
        "106.52.70.76"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "be13ee03-60e8-4af1-880a-e84e5abdf6bc",
        "RealServerSet": [
            {
                "RealServerIP": "106.52.70.76",
                "RealServerId": "rs-hx4u5379"
            }
        ]
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.TagResourcesFailed Failed to add the tag to the resource.
FailedOperation.UnTagResourcesFailed Failed to unbind the tag.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.DuplicateRS The RealServer already exists.
InvalidParameterValue.InvalidTags The tag is not found or you have no access permission to it.
InvalidParameterValue.ProjectIdNotBelong The project does not belong to this user.
LimitExceeded.TagQuota Insufficient tags
MissingParameter Missing parameter.
ResourceUnavailable The resource is unavailable.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnknownParameter Unknown parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy