tencent cloud

Feedback

Using API Inspector

Last updated: 2023-03-07 18:16:40
    API Inspector is a new feature of TencentCloud API. It enables you to view the API calls associated with console operations. In addition, it can automatically generate API code snippets in different languages and work with API Explorer for online debugging.
    Note:
    API Inspector displays only open TencentCloud API 3.0 calls.
    API Inspector is currently in beta for both the console and users. For the CVM console, this feature is currently available only in the menus of instance, CDH, placement group, AS, SSH key, and recycle bin.
    Refreshing your current page in the browser will remove previous call records.

    Benefits

    API Inspector and API Explorer together offer an integrated solution for TencentCloud API users to learn and debug APIs, with the following features:
    Automatic recording: if you want to understand the APIs behind a specific feature, you can use API Inspector to get the call information of related APIs when using the feature in the console. For more information, please see Automatic API call recording.
    Code generation: API Inspector can automatically generate API code snippets in various languages with prepopulated parameters, which you can run directly. For more information, please see Quick API code generation.
    Online debugging: API Inspector comes with API Explorer’s quick online debugging feature, and can perform various tasks such as automatic multilingual SDK code generation, online call capacity, sending real requests, and automatic signature string generation, making the SDKs easier to use. For more information, please see API Explorer online debugging.

    Features

    Enabling API Inspector

    Please follow the steps below to enable the API Inspector feature:
    1. Log in to the CVM Console.
    2. Select
    
    > API at the top of the page to enable API Inspector as shown below:
    
    

    Automatic API call recording

    This document will use renaming an instance as an example to describe the automatic recording feature of API Inspector:
    1. Rename an instance to "API Inspector". For detailed directions, please see Renaming Instances.
    2. Enable the API Inspector feature to view all API calls involved in the renaming operation.
    
    You can check "Hide Describe APIs" to view only the core feature-related APIs as shown below:
    
    

    Quick API code generation

    After you record an API used in a console operation, you can click the API name to quickly generate API code snippets with prepopulated parameters in Java, Python, Node.js, PHP, Go, and .NET languages. You can select
    
    to copy the code snippet in the corresponding format as shown below:
    
    

    API Explorer online debugging

    You can select
    
    or Go to API Explorer to debug features with API Explorer. You can also select
    
    to view the corresponding API documentation as shown below:
    
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support