DescribeProjects

最后更新时间：2025-10-30 21:53:34

DescribeProjects

最后更新时间： 2025-10-30 21:53:34

1. API Description

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

The API is used to query project 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: DescribeProjects.
Version	Yes	String	Common Params. The value used for this API: 2021-07-28.
Region	No	String	Common Params. This parameter is not required for this API.
Offset	No	Integer	Offset. Default value is 0.
Limit	No	Integer	Number of returns. Default value is 20, maximum is 100
ProjectIds.N	No	Array of String	Array of Project ID.
ProjectName	No	String	Project name.
OrderBy	No	String	Column for sorting.
Ascend	No	Boolean	Whether in ascending order.
TagFilters.N	No	Array of TagSpec	Array of Tags.

3. Output Parameters

Parameter Name	Type	Description
ProjectSet	Array of Project	Project list. Note: This field may return null, indicating that no valid value is found.
Total	Integer	Total number of projects.
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 Queries project list

Queries project list

Input Example

POST / HTTP/1.1
Host: pts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjects
<Common request parameters>

{
    "ProjectIds": [
        "project-xx"
    ]
}

Output Example

{
    "Response": {
        "ProjectSet": [
            {
                "AppId": 123,
                "Uin": "456",
                "SubAccountUin": "789",
                "CreatedAt": "2021-08-23T20:59:07+08:00",
                "UpdatedAt": "2021-08-23T20:59:07+08:00",
                "ProjectId": "project-ks8lr6m2",
                "Name": "MyProject",
                "Description": "Test project",
                "Tags": [
                    {
                        "TagKey": "owner",
                        "TagValue": "lyla"
                    }
                ],
                "Status": 1
            }
        ],
        "RequestId": "abc",
        "Total": 1
    }
}

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

Tencent Cloud CLI 3.0

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
AuthFailure	CAM signature/authentication error.
AuthFailure.UnauthorizedOperation	The current request is not authorized by CAM.
FailedOperation	Operation failed.
FailedOperation.AccessTagFail	Failed to obtain tags.
FailedOperation.DbQueryFailed	Failed to query database.
FailedOperation.DbRecordCreateFailed	Failed to create database record.
FailedOperation.DbRecordUpdateFailed	Failed to update database record.
FailedOperation.ResourceNotFound	The resource does not exist.
FailedOperation.SendRequest	Failed to send request.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
ResourceNotFound	The resource does not exist.
UnauthorizedOperation	Unauthorized operation.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud