Domain name for API request: teo.tencentcloudapi.com.
This API is used to obtain a list of origin groups.
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: DescribeOriginGroup. |
Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
Region | No | String | Common Params. This parameter is not required. |
ZoneId | No | String | (Required) Site ID |
Offset | No | Integer | The paginated query offset. Default value: 0 |
Limit | No | Integer | Limit on paginated queries. Value range: 1-1000. Default value: 20. |
Filters.N | No | Array of AdvancedFilter | Filters. Each filter can have up to 20 entries. See below for details:origin-group-id Filter by the origin group ID. Format: origin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a Fuzzy query is not supported origin-group-name Filter by the origin group name Fuzzy query is supported. When fuzzy query is used, only one origin groupsource site group name is supported |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total number of records. |
OriginGroups | Array of OriginGroup | Origin group information. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the list of origin groups by a specified ID.
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOriginGroup
<Common request parameters>
{
"Filters": [
{
"Name": "origin-group-id",
"Values": [
"origin-057c4d82-383c-11ee-8888-525400682e90"
]
}
]
}
{
"Response": {
"OriginGroups": [
{
"CreateTime": "2023-08-11T19:41:33Z",
"GroupId": "origin-057c4d82-383c-11ee-8888-525400682e90",
"HostHeader": "",
"Name": "test_ruichaolin",
"Records": [
{
"Private": false,
"PrivateParameters": [],
"Record": "4.4.4.4",
"RecordId": "record-3492ee3b-383c-11ee-8888-525400682e90",
"Type": "IP_DOMAIN",
"Weight": 40
}
],
"References": [],
"Type": "HTTP",
"UpdateTime": "2023-08-11T19:41:33Z"
}
],
"RequestId": "a2e38df8-5800-4495-bd61-b6761b070d50",
"TotalCount": 1
}
}
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 |
---|---|
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |
Was this page helpful?