Domain name for API request: teo.tencentcloudapi.com.
This API is used to get the details of the origin group.
A maximum of 20 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: DescribeOriginGroupDetail. |
Version | Yes | String | Common Params. The value used for this API: 2022-01-06. |
Region | No | String | Common Params. This parameter is not required for this API. |
OriginId | Yes | String | Origin group ID |
ZoneId | Yes | String | Site ID |
Parameter Name | Type | Description |
---|---|---|
OriginId | String | Origin group ID |
OriginName | String | Origin group name |
Type | String | Origin-pull configuration typearea : Origin-pull by the client IP’s region specified by Area in OriginRecord.weight : Origin-pull by the weight specified by Weight in OriginRecord. |
Record | Array of OriginRecord | Record |
UpdateTime | Timestamp ISO8601 | Update time |
ZoneId | String | Site ID |
ZoneName | String | Site name |
OriginType | String | Origin type Note: This field may return null , indicating that no valid value can be obtained. |
ApplicationProxyUsed | Boolean | Whether the origin group uses layer-4 proxy. Note: This field may return null, indicating that no valid values can be obtained. |
LoadBalancingUsed | Boolean | Whether the origin group is used for load balancing. Note: This field may return null, indicating that no valid values can be obtained. |
LoadBalancingUsedType | String | Proxy mode of the load balancing task associated with the origin group.none : Not used for load balancing.dns_only : Used for DNS-only load balancing.proxied : Used for proxied load balancing.both : Used for both DNS-only and proxied load balancing.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. |
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOriginGroupDetail
<Common request parameters>
{
"OriginId": "origin-xxx",
"ZoneId": "zone-xxx"
}
{
"Response": {
"RequestId": "xx",
"OriginId": "origin-136db381-8d3d-11ec-89a4-00ff977fb3c8",
"OriginName": "oname",
"ZoneId": "zone-xxx",
"ZoneName": "123.com",
"Record": [
{
"Area": [],
"Port": 10,
"Record": "1.2.3.4",
"RecordId": "record-4b2dbd84-8d9a-11ec-9527-00ff977fb3c8",
"Weight": 100
}
],
"Type": "weight",
"OriginType": "self",
"ApplicationProxyUsed": false,
"LoadBalancingUsed": false,
"LoadBalancingUsedType": "none",
"UpdateTime": "2020-09-22T00:00:00+00:00"
}
}
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 |
---|---|
ResourceNotFound | The resource doesn’t exist. |
Was this page helpful?