tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeActionFieldConfigList

Last updated: 2024-09-25 10:28:05

1. API Description

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

This API is used to obtain the dynamic configuration parameters of the action field based on action ID, including action-specific parameters and common parameters.

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: DescribeActionFieldConfigList.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region No String Common Params. This parameter is not required.
ActionIds.N Yes Array of Integer Action ID list
ObjectTypeId Yes Integer Object type ID

3. Output Parameters

Parameter Name Type Description
Common Array of ActionFieldConfigResult List of general filed configuration parameters
Results Array of ActionFieldConfigResult List of action filed configuration parameters
ResourceOffline Array of ResourceOffline Information on the decommissioned resource
Note: This field may return null, indicating that no valid values can be obtained.
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 Example

Input Example

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



{
    "ObjectTypeId": "1",
    "ActionIds": [
        "1"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "f3433a9a-e8fd-40b9-88e7-dd8b3f1a181f",
        "Common": [
            {
                "ActionId": 1,
                "ActionName": "Shut down",
                "ConfigDetail": [
                    {
                        "Type": "input",
                        "Lable": "Action alias",
                        "Field": "AliasTitle",
                        "DefaultValue": "",
                        "Config": "{}",
                        "Required": 0,
                        "Validate": "{}",
                        "Visible": "{}"
                    },
                    {
                        "Type": "number",
                        "Lable": "Pre-wait time (s)",
                        "Field": "PreTimeWait",
                        "DefaultValue": "0",
                        "Config": "{\"max\": 86400, \"min\": 0, \"tooltip\": \"Only for auto-advance mode\"}",
                        "Required": 1,
                        "Validate": "{}",
                        "Visible": "{}"
                    },
                    {
                        "Type": "number",
                        "Lable": "Post-wait time (s)",
                        "Field": "AfterTimeWait",
                        "DefaultValue": "0",
                        "Config": "{\"max\": 86400, \"min\": 0, \"tooltip\": \"Only for auto-advance mode\"}",
                        "Required": 1,
                        "Validate": "{}",
                        "Visible": "{}"
                    },
                    {
                        "Type": "number",
                        "Lable": "Action timeout period (s)",
                        "Field": "ActionTimeout",
                        "DefaultValue": "1800",
                        "Config": "{\"max\": 86400, \"min\": 0, \"tooltip\": \"The timeout period for the action\"}",
                        "Required": 1,
                        "Validate": "{}",
                        "Visible": "{}"
                    }
                ]
            }
        ],
        "Results": []
    }
}

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
AuthFailure CAM signature/authentication error.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Parameters are missing
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy