1. API Description
Domain name for API request: tag.tencentcloudapi.com.
This API is used to get project lists.
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: 2018-08-13. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| AllList | Yes | Integer | If this parameter is 1, all projects (including hidden ones) will be queried. If it is 0, only non-hidden projects will be queried. |
| Limit | Yes | Integer | Number of entries per page. Fixed value: 1,000. |
| Offset | Yes | Integer | Pagination offset. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total number of data entries. |
| Projects | Array of Project | Project list. |
| 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 Getting project lists
Input Example
POST / HTTP/1.1
Host: tag.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjects
<Common request parameters>
{
"Limit": "500",
"AllList": "0",
"Offset": "0"
}
Output Example
{
"Response": {
"Total": 1,
"Projects": [
{
"ProjectId": 1024701,
"ProjectName": "test1",
"CreatorUin": 100000548134,
"ProjectInfo": "",
"CreateTime": "2021-10-13 11:03:30"
}
],
"RequestId": "d75bbc07-f5bd-4020-b4bd-f877e9ccd1db"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| AuthFailure | Error with CAM signature/authentication. |
| AuthFailure.UnauthorizedOperation | CAM authentication failed. |
| FailedOperation | The operation failed. |
| InvalidParameter | Incorrect parameter. |
是
否
本页内容是否解决了您的问题？