tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud EdgeOne
    Documentation

    DescribeOriginGroupDetail

    Last updated: 2023-03-09 17:41:45

    1. API Description

    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.

    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: 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

    3. Output Parameters

    Parameter Name Type Description
    OriginId String Origin group ID
    OriginName String Origin group name
    Type String Origin-pull configuration type
    area: 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.

    4. Example

    Example1 Getting details of the origin group

    Input Example

    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"
}

    Output Example

    {
    "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"
    }
}

    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
    ResourceNotFound The resource doesn’t exist.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy