tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAllNamespaces

Last updated: 2023-08-11 16:09:23

1. API Description

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

This API is used to query all namespaces.

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: DescribeAllNamespaces.
Version Yes String Common Params. The value used for this API: 2018-07-24.
Region No String Common Params. This parameter is not required.
SceneType Yes String Filter by use case. Currently, the only valid value is ST_ALARM (alarm type).
Module Yes String Value fixed at "monitor"
MonitorTypes.N No Array of String Filter by monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring). If this parameter is left empty, all will be queried by default
Ids.N No Array of String Filter by namespace ID. If this parameter is left empty, all will be queried

3. Output Parameters

Parameter Name Type Description
QceNamespaces CommonNamespace Alarm policy type of Tencent Cloud service (disused)
CustomNamespaces CommonNamespace Other alarm policy type (disused)
QceNamespacesNew Array of CommonNamespace Alarm policy type of Tencent Cloud service
CustomNamespacesNew Array of CommonNamespace Other alarm policy type (not supported currently)
CommonNamespaces Array of CommonNamespaceNew General alarm policy type, including TAPM, RUM, and CAT.
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 all namespaces

Input Example

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

{
    "Module": "monitor",
    "MonitorTypes": [
        "MT_QCE"
    ],
    "SceneType": "ST_ALARM"
}

Output Example

{
    "Response": {
        "QceNamespaces": {
            "Id": "",
            "Name": "",
            "ProductName": "",
            "Value": "",
            "Config": "",
            "AvailableRegions": [],
            "DashboardId": "",
            "SortId": 0
        },
        "QceNamespacesNew": [
            {
                "Id": "xxxxxxx",
                "Name": "Direct Connect - dedicated tunnel",
                "ProductName": "Direct Connect - dedicated tunnel",
                "Value": "qce/dcx",
                "Config": "...",
                "AvailableRegions": [
                    "gz",
                    "sh"
                ],
                "DashboardId": "dcchannel",
                "SortId": 500
            }
        ],
        "CustomNamespaces": {
            "Id": "",
            "Name": "",
            "ProductName": "",
            "Value": "",
            "Config": "",
            "AvailableRegions": [],
            "DashboardId": "",
            "SortId": 0
        },
        "CustomNamespacesNew": [
            {
                "Id": "=wenlong_sidecar",
                "Name": "=wenlong_sidecar",
                "ProductName": "=wenlong_sidecar",
                "Value": "=wenlong_sidecar",
                "Config": "",
                "AvailableRegions": [],
                "DashboardId": "=wenlong_sidecar",
                "SortId": 0
            }
        ],
        "CommonNamespaces": [
            {
                "Id": "performance_metric",
                "MonitorType": "MT_TAW",
                "Name": "Performance metric",
                "Dimensions": []
            }
        ],
        "RequestId": "d96ec542-6547-4af2-91ac-fee85c1b8b85"
    }
}

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.
FailedOperation.DoHTTPTransferFailed Backend service timed out.
UnsupportedOperation Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy