- Product Introduction
- Overview
- Strengths
- Features
- Use Cases
- CloudAudit-Enabled Services and APIs
- Overview
- Computing
- Container
- Network
- Storage
- Database
- CDN and Acceleration
- Serverless
- Middleware
- Video Services
- Video Services
- Big Data Platform
- Security Management
- Data Security
- Application Security
- Management and Audit
- Cloud Resource Management
- Management and Support
- Cloud Communications
- Gaming Services
- Education Services
- Purchase Guide
- Getting Started
- API Documentation
- Operation Guide
- PHP SDK Documentation
- FAQs
- Contact Us
- Glossary
- Product Introduction
- Overview
- Strengths
- Features
- Use Cases
- CloudAudit-Enabled Services and APIs
- Overview
- Computing
- Container
- Network
- Storage
- Database
- CDN and Acceleration
- Serverless
- Middleware
- Video Services
- Video Services
- Big Data Platform
- Security Management
- Data Security
- Application Security
- Management and Audit
- Cloud Resource Management
- Management and Support
- Cloud Communications
- Gaming Services
- Education Services
- Purchase Guide
- Getting Started
- API Documentation
- Operation Guide
- PHP SDK Documentation
- FAQs
- Contact Us
- Glossary
DescribeRecorder
Last updated: 2020-12-17 17:00:42
This document is currently invalid. Please refer to the documentation page of the product.
1. API Description
Domain name for API request: cloudaudit.tencentcloudapi.com.
This API is used to display current configurations and status of a recorder.
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 parameter. The value used for this API: DescribeRecorder. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-03-19. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Enable | Boolean | Whether to enable the recorder. Valid values: true (enable), false (disable). |
| Name | String | Recorder name |
| LastErrorMessage | String | Last error message of the recorder, which corresponds to LastErrorCode. |
| LastStatus | String | The status of the recorder when it recorded information last time. Valid values: PENDING, OK, FAILED. |
| ResourceTypes | Array of RecordResourceType | List of the resource types monitored by the recorder Note: this field may return null, indicating that no valid values can be obtained. |
| LastStartTime | Timestamp | Time when the recorder was enabled last time |
| LastErrorCode | String | Last error code of the recorder |
| LastStopTime | Timestamp | Time when the recorder was disabled last time |
| AllSupported | Boolean | Whether to monitor all currently supported resource types. Valid values: true (yes), false (no). |
| CreateTime | Timestamp | Recorder creation time |
| Role | String | Role name authorized to CFA |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Viewing recorder information
Input Example
https://cloudaudit.tencentcloudapi.com/?Action=DescribeRecorder
&<Common request parameters>Output Example
{
"Response": {
"Name": "test_ayi",
"Enable": true,
"AllSupported": false,
"ResourceTypes": [
{
"ResourceType": "TCS::CAM::User",
"PolicyName": "QcloudCamReadOnlyAccess",
"Service": "cam",
"ServiceName": "CAM",
"ResourceTypeName": "CAM - Sub-user",
"UpdateTime": "2019-11-12 12:31:30"
},
{
"ResourceType": "TCS::CAM::Role",
"PolicyName": "QcloudCamReadOnlyAccess",
"Service": "cam",
"ServiceName": "CAM",
"ResourceTypeName": "CAM - Role",
"UpdateTime": "2019-11-12 12:31:30"
},
{
"ResourceType": "TCS::VPC::SecurityGroup",
"PolicyName": "QcloudVPCReadOnlyAccess",
"Service": "vpc",
"ServiceName": "VPC",
"ResourceTypeName": "VPC - Security group",
"UpdateTime": "2019-11-12 12:31:30"
},
{
"ResourceType": "TCS::CAM::Policy",
"PolicyName": "QcloudCamReadOnlyAccess",
"Service": "cam",
"ServiceName": "CAM",
"ResourceTypeName": "CAM - Policy",
"UpdateTime": "2019-11-12 12:31:30"
}
],
"Role": "config_test",
"LastErrorCode": "",
"LastErrorMessage": "",
"LastStatus": "PENDING",
"LastStartTime": "2019-11-12 12:36:00",
"LastStopTime": "2019-11-12 12:35:52",
"CreateTime": "2019-11-08 17:28:31",
"RequestId": "920938b6-5728-49b4-b193-8a7f1dffd9fe"
}
}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 NodeJS
- 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 |
|---|---|
| ResourceNotFound.RecorderNotFound | Recorder not found. |
Yes
No
Was this page helpful?