文档中心>API 中心>混沌演练平台>任务相关接口>获取动作栏位配置参数列表

获取动作栏位配置参数列表

最近更新时间:2024-07-26 14:53:18

我的收藏

1. 接口描述

接口请求域名: cfg.tencentcloudapi.com 。

根据动作ID获取动作栏位动态配置参数信息,里面包含动作自有和通用两部分参数。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeActionFieldConfigList。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
ActionIds.N Array of Integer 动作ID列表
示例值:[1,2,3]
ObjectTypeId Integer 对象类型ID
示例值:10

3. 输出参数

参数名称 类型 描述
Common Array of ActionFieldConfigResult 通用栏位配置列表
示例值:[{"ActionId": 4, "ActionName": "CPU利用率高", "ConfigDetail": [ {"Type": "input", "Lable": "动作别名", "Field": "AliasTitle", "DefaultValue": "", "Config": "{}", "Required": 0, "Validate": "{}", "Visible": "{}"}]}]
Results Array of ActionFieldConfigResult 动作栏位配置列表
示例值:[{"ActionId": 4, "ActionName": "CPU利用率高", "ConfigDetail": [ {"Type": "number", "Lable": "cpu利用率(%)", "Field": "percentage", "DefaultValue": "90", "Config": "{"max": 100, "min": 0}", "Required": 0, "Validate": "{}", "Visible": "{}"}]}]
ResourceOffline Array of ResourceOffline 资源下线信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ResourceId": 4, "ResourceDeleteTime": "2023-12-14","ResourceDeleteMessage": "由于该动作不具备手动中止能力,已将该动作下线。现有新的故障动作替换,请参考探针管理文档,在实例安装探针后重新创建新的演练执行。"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

输入示例

POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeActionFieldConfigList
<公共请求参数>

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

输出示例

{
    "Response": {
        "RequestId": "f3433a9a-e8fd-40b9-88e7-dd8b3f1a181f",
        "Common": [
            {
                "ActionId": 1,
                "ActionName": "关机",
                "ConfigDetail": [
                    {
                        "Type": "input",
                        "Lable": "动作别名",
                        "Field": "AliasTitle",
                        "DefaultValue": "",
                        "Config": "{}",
                        "Required": 0,
                        "Validate": "{}",
                        "Visible": "{}"
                    },
                    {
                        "Type": "number",
                        "Lable": "前置等待时间(s)",
                        "Field": "PreTimeWait",
                        "DefaultValue": "0",
                        "Config": "{\"max\": 86400, \"min\": 0, \"tooltip\": \"仅限用于自动推进模式\"}",
                        "Required": 1,
                        "Validate": "{}",
                        "Visible": "{}"
                    },
                    {
                        "Type": "number",
                        "Lable": "后置等待时间(s)",
                        "Field": "AfterTimeWait",
                        "DefaultValue": "0",
                        "Config": "{\"max\": 86400, \"min\": 0, \"tooltip\": \"仅限用于自动推进模式\"}",
                        "Required": 1,
                        "Validate": "{}",
                        "Visible": "{}"
                    },
                    {
                        "Type": "number",
                        "Lable": "动作超时时间(s)",
                        "Field": "ActionTimeout",
                        "DefaultValue": "1800",
                        "Config": "{\"max\": 86400, \"min\": 0, \"tooltip\": \"动作的超时时间\"}",
                        "Required": 1,
                        "Validate": "{}",
                        "Visible": "{}"
                    }
                ]
            }
        ],
        "Results": []
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。