History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Domain name for API request: gaap.intl.tencentcloudapi.com.
This API is used to query origin server information. It can query all origin servers under the specified project name, and supports fuzzy query by specified IPs or domain names.
A maximum of 1000 requests can be initiated per second for this API.
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: DescribeRealServers. |
| 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 | Queries the project ID to which the origin server belongs. -1: all projects. |
| SearchValue | No | String | Origin server IP or domain name to be queried. The fuzzy match is supported. |
| Offset | No | Integer | Offset, which is 0 by default. |
| Limit | No | Integer | Quantity of values to return. The default value is 20 and the maximum value is 50. |
| TagSet.N | No | Array of TagPair | Tag list. If this field exists, the list of the resources with the tag will be pulled. It supports up to 5 tags. If there are two or more tags, the origin servers tagged any of them will be pulled. |
| Filters.N | No | Array of Filter | Filter conditions. The value of the name of the filter (RealServerName, RealServerIP) |
| Parameter Name | Type | Description |
|---|---|---|
| RealServerSet | Array of BindRealServerInfo | An information list of origin server |
| TotalCount | Integer | The quantity of origin servers |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealServers
<Common request parameters>
{
"ProjectId": "0",
"SearchValue": "'1.1.1.1'"
}{
"Response": {
"RealServerSet": [
{
"RealServerId": "rs123",
"RealServerIP": "1.1.1.1",
"RealServerName": "rsname",
"ProjectId": 0,
"TagSet": []
}
],
"TotalCount": 1,
"RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.UserNotConfirmProtocol | Protocol not activated. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| 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. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários