tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeProjects

Last updated: 2023-04-27 15:44:54

1. API Description

Domain name for API request: rum.tencentcloudapi.com.

This API is used to get the list of projects (under teams created by an instance).

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-06-22.
Region No String Common Params. This parameter is not required for this API.
Limit Yes Integer Number of items per page (integer)
Offset Yes Integer Page number (integer)
Filters.N No Array of Filter Filter parameter. Pass in {"Name": "IsDemo", "Values":["1"]} for the demo mode.
IsDemo No Integer This parameter has been disused. You need to indicate whether the demo mode is used in Filters.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of items in the list
ProjectSet Array of RumProject Project list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the RUM application list by filter

This example shows you how to get the RUM application list by filter.

Input Example

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

{
    "Limit": "20",
    "Filters": [
        {
            "Values": [
                "'Test project name 2'",
                "'Test project name'"
            ],
            "Name": "'Name'"
        }
    ],
    "Offset": "1"
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "ProjectSet": [],
        "RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"
    }
}

Example2 Getting the RUM application list

This examples shows you how to get the RUM application list.

Input Example

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

{
    "Limit": "20",
    "Offset": "1"
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "ProjectSet": [],
        "RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceNotFound.NoInstance The instance does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy