tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSites

Last updated: 2024-11-27 15:19:15

1. API Description

Domain name for API request: cdc.intl.tencentcloudapi.com.

This API is used to query the site list.

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: DescribeSites.
Version Yes String Common Params. The value used for this API: 2020-12-14.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
SiteIds.N No Array of String Filter by site id.
Name No String Name of fuzzy matching site
Offset No Integer Offset, 0 by default For further information on Offset, please refer to relevant sections in API [Overview] (https://www.tencentcloud.com/document/api/213/15688?from_cn_redirect=1).
Limit No Integer Number of returned pieces, 20 by default and can be up to 100. For further information on Limit, please refer to relevant sections in API [Overview] (https://www.tencentcloud.com/document/api/213/15688?from_cn_redirect=1).

3. Output Parameters

Parameter Name Type Description
SiteSet Array of Site List of sites that meet the query conditions
TotalCount Integer Number of sites that meet the conditions
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.

4. Example

Example1 Querying the site list.

This example shows you how to query the site list.

Input Example

https://cdc.intl.tencentcloudapi.com/?Action=DescribeSites
&<Common request parameters>

Output Example

{
    "Response": {
        "SiteSet": [
            {
                "SiteId": "site-98dj3kd",
                "Name": "my-site",
                "Description": "my first site",
                "CreateTime": "2020-12-25T08:39:57Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "60f56861-42af-4778-96c2-018d35141a7f"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy