History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Response format of dynamic action parameters
Used by actions: DescribeActionFieldConfigList.
| Name | Type | Description |
|---|---|---|
| Type | String | Component type The options are as follows: input: text box textarea: multi-line text box number: number input box select: selector cascader: cascade selector radio: single choice time: time selection |
| Lable | String | Component label |
| Field | String | Unique identifier of the component, key when it is sent back to the backend |
| DefaultValue | String | Default value Note: This field may return null, indicating that no valid values can be obtained. |
| Config | String | The supported configuration items are as follows. You can select the configuration items as needed. If no configuration is required, set the value to {}. { placeholder: string (placeholder) tooltip: string (prompt message) reg: RegExp (regular expression for the input content format) max: number (maximum number of input characters for text boxes and upper limit of the input number for number input boxes) min: number (lower limit of the input number for number input boxes) step: number (step size for number input boxes; default value: 1) format: string (format for time selection, for example YYYY-MM-DD and YYYY-MM-DD HH:mm:ss) separator: string[] (separator for multi-line input boxes. If it is left blank, no separator is used, and the text string entered by the user is returned directly.) multiple: boolean (multiple-choice or not, valid for selectors and cascade selectors) options: selector options (support the following two forms) Directly provide the option array: { value: string; label: string }[] Obtain options by calling the API: { api: string (API URL), params: string[] (interface parameters, corresponding to field of the parameter configuration. The frontend uses the input values of all components corresponding to field as parameters to query data. If no value is input, the frontend directly requests data when components are loaded.) } } |
| Required | Integer | Whether it is required (0: no; 1: yes) |
| Validate | String | The compute configuration passes the verification when other fields that it depends on meet the conditions. (For example, at least one of the three form items must be filled in.) [fieldName, { config: This item is retained and will be refined based on subsequent scenes. } ] |
| Visible | String | Whether it is visible |
Action field configuration result
Used by actions: DescribeActionFieldConfigList.
| Name | Type | Description |
|---|---|---|
| ActionId | Integer | Action ID |
| ActionName | String | Action name |
| ConfigDetail | Array of ActionFieldConfigDetail | Filed configuration details corresponding to the action |
Action library filtering field
Used by actions: DescribeActionLibraryList, DescribeTaskList, DescribeTemplateList.
| Name | Type | Required | Description |
|---|---|---|---|
| Keyword | String | Yes | Keyword |
| Values | Array of String | Yes | Content for search |
Action library data list
Used by actions: DescribeActionLibraryList.
| Name | Type | Description |
|---|---|---|
| ActionName | String | Action name |
| Desc | String | Action description |
| ActionType | String | Action type: ["platform" and "custom"] |
| CreateTime | String | Creation time |
| Creator | String | Creator |
| UpdateTime | String | Update time |
| RiskDesc | String | Action risk description |
| ActionId | Integer | Action ID |
| AttributeId | Integer | Action attribute (1: fault; 2: recovery) |
| RelationActionId | Integer | ID of the associated action |
| ActionCommand | String | Operation command |
| ActionCommandType | Integer | Action type (0: tat; 1: cloud API) |
| ActionContent | String | Parameters of the custom action, in JSON string format |
| ResourceType | String | Level-2 type Note: This field may return null, indicating that no valid values can be obtained. |
| ActionDetail | String | Action description Note: This field may return null, indicating that no valid values can be obtained. |
| IsAllowed | Boolean | Whether to allow usage by the current account Note: This field may return null, indicating that no valid values can be obtained. |
| ActionBestCase | String | Link to best practices Note: This field may return null, indicating that no valid values can be obtained. |
| ObjectType | String | Object type Note: This field may return null, indicating that no valid values can be obtained. |
| MetricIdList | Array of Integer | Monitoring metric ID list Note: This field may return null, indicating that no valid values can be obtained. |
| IsNewAction | Boolean | Whether the action is new Note: This field may return null, indicating that no valid values can be obtained. |
Application information on Application Performance Monitoring
Used by actions: DescribeTask, DescribeTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | Yes | Business ID Note: This field may return null, indicating that no valid values can be obtained. |
| ServiceNameList | Array of String | Yes | Application name Note: This field may return null, indicating that no valid values can be obtained. |
| RegionId | Integer | No | Region ID Note: This field may return null, indicating that no valid values can be obtained. |
Protection policy
Used by actions: DescribeTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskPolicyIdList | Array of String | Yes | Protection policy ID list |
| TaskPolicyStatus | String | Yes | Protection policy status |
| TaskPolicyRule | String | Yes | Policy rule |
| TaskPolicyDealType | Integer | Yes | Process method when the guardrail policy takes effect. 1: sequential execution, 2: pausing. Note: This field may return null, indicating that no valid values can be obtained. |
Object type
Used by actions: DescribeObjectTypeList.
| Name | Type | Description |
|---|---|---|
| ObjectTypeId | Integer | Object type ID |
| ObjectTypeTitle | String | Object type name |
| ObjectTypeLevelOne | String | Level-1 object type |
| ObjectTypeParams | ObjectTypeConfig | Object type parameters |
| ObjectTypeJsonParse | ObjectTypeJsonParse | JSON parsing rule for TKE APIs. If the value is null, no parsing is needed. Note: This field may return null, indicating that no valid values can be obtained. |
| ObjectHasNewAction | Boolean | Whether new action is included Note: This field may return null, indicating that no valid values can be obtained. |
Object type configuration
Used by actions: DescribeObjectTypeList.
| Name | Type | Description |
|---|---|---|
| Key | String | Primary key |
| Fields | Array of ObjectTypeConfigFields | List of object type configuration fields |
Field information on the experiment resource object
Used by actions: DescribeObjectTypeList.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | instanceId |
| Header | String | Yes | Instance ID |
| Transfer | String | No | Whether the field value needs to be translated. If not, this field returns null. Note: This field may return null, indicating that no valid values can be obtained. |
| JsonParse | String | No | Value returned for container Pod resources Note: This field may return null, indicating that no valid values can be obtained. |
Value returned for container Pod resources
Used by actions: DescribeObjectTypeList.
| Name | Type | Description |
|---|---|---|
| NameSpace | String | Namespace Note: This field may return null, indicating that no valid values can be obtained. |
| WorkloadName | String | Workload name Note: This field may return null, indicating that no valid values can be obtained. |
| LanIP | String | Node IP address Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | Node ID Note: This field may return null, indicating that no valid values can be obtained. |
Guardrail policy triggering log
Used by actions: DescribeTaskPolicyTriggerLog.
| Name | Type | Description |
|---|---|---|
| TaskId | Integer | Experiment ID Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | Name Note: This field may return null, indicating that no valid values can be obtained. |
| TriggerType | Integer | Type. 0: trigger; 1: recovery. Note: This field may return null, indicating that no valid values can be obtained. |
| Content | String | Content Note: This field may return null, indicating that no valid values can be obtained. |
| CreatTime | String | Triggering time Note: This field may return null, indicating that no valid values can be obtained. |
Decommissioned resource
Used by actions: DescribeActionFieldConfigList.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceId | Integer | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| ResourceDeleteTime | String | No | Resource decommissioning time Note: This field may return null, indicating that no valid values can be obtained. |
| ResourceDeleteMessage | String | No | Resource decommissioning reminder Note: This field may return null, indicating that no valid values can be obtained. |
Tag information, which is used during experiment resource creation and editing.
Used by actions: CreateTaskFromTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
List of displayed tags
Used by actions: DescribeTask, DescribeTaskList, DescribeTemplate, DescribeTemplateList.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
Task
Used by actions: DescribeTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskId | Integer | Yes | Task ID |
| TaskTitle | String | Yes | Task name |
| TaskDescription | String | Yes | Task description |
| TaskTag | String | Yes | Custom tag Note: This field may return null, indicating that no valid values can be obtained. |
| TaskStatus | Integer | Yes | Task status. 1001: not started; 1002: in progress (executing); 1003: in progress (paused); 1004: execution ended. Note: This field may return null, indicating that no valid values can be obtained. |
| TaskStatusType | Integer | Yes | Task end status, indicating the status of the task when it ends. 0: not ended; 1: successful; 2: failed; 3: terminated. |
| TaskProtectStrategy | String | Yes | Protection policy Note: This field may return null, indicating that no valid values can be obtained. |
| TaskCreateTime | String | Yes | Task creation time |
| TaskUpdateTime | String | Yes | Task update time |
| TaskGroups | Array of TaskGroup | Yes | Task action group |
| TaskStartTime | String | Yes | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| TaskEndTime | String | Yes | End time Note: This field may return null, indicating that no valid values can be obtained. |
| TaskExpect | Integer | Yes | Whether expectations are met. 1: expectations met; 2: expectations not met. Note: This field may return null, indicating that no valid values can be obtained. |
| TaskSummary | String | Yes | Experiment record Note: This field may return null, indicating that no valid values can be obtained. |
| TaskMode | Integer | Yes | Task mode. 1: manual execution; 2: automatic execution. |
| TaskPauseDuration | Integer | Yes | Automatic pause duration. Unit: minutes. |
| TaskOwnerUin | String | Yes | Main account that creates the experiment |
| TaskRegionId | Integer | Yes | Region ID |
| TaskMonitors | Array of TaskMonitor | Yes | Monitoring metric list Note: This field may return null, indicating that no valid values can be obtained. |
| TaskPolicy | DescribePolicy | Yes | Protection policy Note: This field may return null, indicating that no valid values can be obtained. |
| Tags | Array of TagWithDescribe | No | Tag list Note: This field may return null, indicating that no valid values can be obtained. |
| TaskPlanId | Integer | No | ID of the associated experiment plan Note: This field may return null, indicating that no valid values can be obtained. |
| TaskPlanTitle | String | No | Name of the associated experiment plan Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationId | String | No | ID of the associated application Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationName | String | No | Name of the associated application Note: This field may return null, indicating that no valid values can be obtained. |
| AlarmPolicy | Array of String | No | Associated alarm metrics Note: This field may return null, indicating that no valid values can be obtained. |
| ApmServiceList | Array of ApmServiceInfo | No | Associated APM services Note: This field may return null, indicating that no valid values can be obtained. |
| VerifyId | Integer | No | ID of the associated threat verification item Note: This field may return null, indicating that no valid values can be obtained. |
| PolicyDealType | Integer | No | Guardrail processing method. 1: roll back sequentially; 2: pause experiment. Note: This field may return null, indicating that no valid values can be obtained. |
Task parameters that need to be configured when an experiment is created by using a template
Used by actions: CreateTaskFromTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskGroupsConfig | Array of TaskGroupConfig | Yes | Action group configurations. The number of configured action groups needs to be consistent with that in the template. |
| TaskTitle | String | No | Experiment name after change. If this parameter is left blank, the template name is used by default. |
| TaskDescription | String | No | Experiment description after change. If this parameter is left blank, the template description is used by default. |
| TaskMode | Integer | No | Experiment execution mode. 1: manual execution; 2: automatic execution. If this parameter is left blank, the template execution mode is used by default. |
| TaskPauseDuration | Integer | No | Automatic pause time of the experiment, in minutes. If this parameter is left blank, the automatic pause time of the template is used by default. |
| Tags | Array of TagWithCreate | No | Experiment tag. If this parameter is left blank, the template tag is used by default. |
| PolicyDealType | Integer | No | Guardrail processing method. 1: roll back sequentially; 2: pause experiment. |
Task group
Used by actions: DescribeTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskGroupId | Integer | Yes | Task action ID |
| TaskGroupTitle | String | Yes | Group name |
| TaskGroupDescription | String | Yes | Group description Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupOrder | Integer | Yes | Task group order |
| ObjectTypeId | Integer | Yes | Object type ID |
| TaskGroupCreateTime | String | Yes | Task group creation time |
| TaskGroupUpdateTime | String | Yes | Task group update time |
| TaskGroupActions | Array of TaskGroupAction | Yes | List of actions in the group |
| TaskGroupInstanceList | Array of String | Yes | Instance list |
| TaskGroupMode | Integer | Yes | Execution mode. 1: sequential execution; 2: execution by stage. |
| TaskGroupDiscardInstanceList | Array of String | No | List of instances not involved in the experiment |
| TaskGroupSelectedInstanceList | Array of String | No | List of instances involved in the experiment Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupInstancesExecuteRule | Array of TaskGroupInstancesExecuteRules | No | Machine selection rule Note: This field may return null, indicating that no valid values can be obtained. |
Task group action
Used by actions: DescribeTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskGroupActionId | Integer | Yes | Task group action ID |
| TaskGroupInstances | Array of TaskGroupInstance | Yes | Action instance list of the task group |
| ActionId | Integer | Yes | Action ID |
| TaskGroupActionOrder | Integer | Yes | Order of actions in the group |
| TaskGroupActionGeneralConfiguration | String | Yes | General configurations of actions in the group Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupActionCustomConfiguration | String | Yes | Custom configurations of actions in the group Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupActionStatus | Integer | Yes | Status of actions in the group |
| TaskGroupActionCreateTime | String | Yes | Action group creation time |
| TaskGroupActionUpdateTime | String | Yes | Action group update time |
| ActionTitle | String | Yes | Action name |
| TaskGroupActionStatusType | Integer | Yes | Status. 0: no status; 1: successful; 2; failed; 3: terminated; 4: skipped. |
| TaskGroupActionRandomId | Integer | Yes | RandomId Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupActionRecoverId | Integer | Yes | RecoverId Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupActionExecuteId | Integer | Yes | ExecuteId Note: This field may return null, indicating that no valid values can be obtained. |
| ActionApiType | Integer | No | Called API type. 0: tat; 1: cloud API. Note: This field may return null, indicating that no valid values can be obtained. |
| ActionAttribute | Integer | No | 1: fault; 2: recovery. Note: This field may return null, indicating that no valid values can be obtained. |
| ActionType | String | No | Action type: platform and custom Note: This field may return null, indicating that no valid values can be obtained. |
| IsExecuteRedo | Boolean | No | Whether retry is allowed Note: This field may return null, indicating that no valid values can be obtained. |
| ActionRisk | String | No | Action risk level Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupActionExecuteTime | Integer | No | Action running time Note: This field may return null, indicating that no valid values can be obtained. |
Action parameters in the action group
Used by actions: CreateTaskFromTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskGroupActionOrder | Integer | No | Order of this action in the action group. The entire order starts from 1. If this parameter is left blank or set to an invalid value, the action whose parameters need to be modified in the template cannot be matched. |
| TaskGroupActionGeneralConfiguration | String | No | General action parameters, which need to be passed in after JSON serialization. The parameters can be obtained by using the template details query API. If this field is left blank, action parameters in the template are used by default. |
| TaskGroupActionCustomConfiguration | String | No | Custom action parameters, which need to be passed in after JSON serialization. The parameters can be obtained by using the template details query API. If this field is left blank, action parameters in the template are used by default. |
Action group configuration item
Used by actions: CreateTaskFromTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskGroupInstances | Array of String | Yes | Instance object associated with the action group |
| TaskGroupTitle | String | No | Action group name. If this parameter is left blank, the action group name in the template is used by default. |
| TaskGroupDescription | String | No | Action group description. If this parameter is left blank, the action group description in the template is used by default. |
| TaskGroupMode | Integer | No | Action group execution mode. 1: sequential execution; 2: execution by stage. If this parameter is left blank, the action execution mode in the template is used by default. |
| TaskGroupActionsConfig | Array of TaskGroupActionConfig | No | Action parameters in the action group. If this field is left blank, the action parameters in the template is used by default. You only need to specify the action whose parameters are to be modified during configuration. |
Task group action instance
Used by actions: DescribeTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskGroupInstanceId | Integer | Yes | Instance ID |
| TaskGroupInstanceObjectId | String | Yes | Instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupInstanceStatus | Integer | Yes | Instance action execution status |
| TaskGroupInstanceCreateTime | String | Yes | Instance creation time |
| TaskGroupInstanceUpdateTime | String | Yes | Instance update time |
| TaskGroupInstanceStatusType | Integer | Yes | Status. 0: no status; 1: successful; 2: failed; 3: terminated; 4: skipped. |
| TaskGroupInstanceStartTime | String | Yes | Execution start time Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupInstanceEndTime | String | Yes | Execution end time Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupInstanceIsRedo | Boolean | No | Whether the instance can be retried Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupInstanceExecuteTime | Integer | No | Action instance execution time Note: This field may return null, indicating that no valid values can be obtained. |
Machine selection rule
Used by actions: DescribeTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskGroupInstancesExecuteMode | Integer | No | Instance selection mode Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupInstancesExecutePercent | Integer | No | Proportion of selected machines in selection by proportion mode Note: This field may return null, indicating that no valid values can be obtained. |
| TaskGroupInstancesExecuteNum | Integer | No | Number of selected machines in selection by quantity mode Note: This field may return null, indicating that no valid values can be obtained. |
Task list information
Used by actions: DescribeTaskList.
| Name | Type | Description |
|---|---|---|
| TaskId | Integer | Task ID |
| TaskTitle | String | Task name |
| TaskDescription | String | Task description |
| TaskTag | String | Task tag Note: This field may return null, indicating that no valid values can be obtained. |
| TaskStatus | Integer | Task status (1001: not started; 1002: in progress; 1003: paused; 1004: ended) |
| TaskCreateTime | String | Task creation time |
| TaskUpdateTime | String | Task update time |
| TaskPreCheckStatus | Integer | 0: not started; 1: in progress; 2: completed. Note: This field may return null, indicating that no valid values can be obtained. |
| TaskPreCheckSuccess | Boolean | Whether the environmental check is passed Note: This field may return null, indicating that no valid values can be obtained. |
| TaskExpect | Integer | Whether the experiment result meets expectations. 1: expectations met; 2: expectations not met. Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationId | String | ID of the associated application Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationName | String | Name of the associated application Note: This field may return null, indicating that no valid values can be obtained. |
| VerifyId | Integer | Verification item ID Note: This field may return null, indicating that no valid values can be obtained. |
| TaskStatusType | Integer | Status. 0: no status; 1: successful; 2: failed; 3: terminated. Note: This field may return null, indicating that no valid values can be obtained. |
Monitoring metrics
Used by actions: DescribeTask.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskMonitorId | Integer | Yes | Experiment monitoring metric ID |
| MetricId | Integer | Yes | Monitoring metric ID Note: This field may return null, indicating that no valid values can be obtained. |
| TaskMonitorObjectTypeId | Integer | Yes | Object type ID of the monitoring metric |
| MetricName | String | Yes | Metric name |
| InstancesIds | Array of String | Yes | Instance ID list |
| MetricChineseName | String | Yes | Metric in Chinese Note: This field may return null, indicating that no valid values can be obtained. |
| Unit | String | Yes | Unit Note: This field may return null, indicating that no valid values can be obtained. |
Experiment report status information
Used by actions: DescribeTask.
| Name | Type | Description |
|---|---|---|
| Stage | Integer | 0: not started; 1: exporting; 2: export successful; 3: export failed. |
| CreateTime | String | Creation time |
| ExpirationTime | String | End time of the validity period |
| Expired | Boolean | Whether it is effective |
| CosUrl | String | Address of the COS experiment report file Note: This field may return null, indicating that no valid values can be obtained. |
| Log | String | Experiment report export log Note: This field may return null, indicating that no valid values can be obtained. |
Template library
Used by actions: DescribeTemplate.
| Name | Type | Description |
|---|---|---|
| TemplateId | Integer | Template library ID |
| TemplateTitle | String | Template library name |
| TemplateDescription | String | Template library description |
| TemplateTag | String | Custom tag Note: This field may return null, indicating that no valid values can be obtained. |
| TemplateIsUsed | Integer | Usage status. 1: in use; 2: not in use. |
| TemplateCreateTime | String | Template library creation time |
| TemplateUpdateTime | String | Template library update time |
| TemplateMode | Integer | Template library mode. 1: manual execution; 2: automatic execution. |
| TemplatePauseDuration | Integer | Automatic pause duration. Unit: minutes. |
| TemplateOwnerUin | String | Main account that creates the experiment |
| TemplateRegionId | Integer | Region ID |
| TemplateGroups | Array of TemplateGroup | Action group |
| TemplateMonitors | Array of TemplateMonitor | Monitoring metrics |
| TemplatePolicy | TemplatePolicy | Guardrail monitoring Note: This field may return null, indicating that no valid values can be obtained. |
| Tags | Array of TagWithDescribe | Tag list Note: This field may return null, indicating that no valid values can be obtained. |
| TemplateSource | Integer | Template library source. 0: self-built; 1: recommended by experts. Note: This field may return null, indicating that no valid values can be obtained. |
| ApmServiceList | Array of ApmServiceInfo | Application information on Application Performance Monitoring Note: This field may return null, indicating that no valid values can be obtained. |
| AlarmPolicy | Array of String | Alarm metrics Note: This field may return null, indicating that no valid values can be obtained. |
| PolicyDealType | Integer | Guardrail processing method. 1: roll back sequentially; 2: pause experiment. Note: This field may return null, indicating that no valid values can be obtained. |
Task group
Used by actions: DescribeTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| TemplateGroupId | Integer | Yes | Template library action ID |
| TemplateGroupActions | Array of TemplateGroupAction | Yes | List of actions in the template library action group |
| Title | String | Yes | Group name |
| Description | String | Yes | Group description Note: This field may return null, indicating that no valid values can be obtained. |
| Order | Integer | Yes | Group order |
| Mode | Integer | Yes | Execution mode. 1: sequential execution; 2: execution by stage. |
| ObjectTypeId | Integer | Yes | Object type ID |
| CreateTime | String | Yes | Group creation time |
| UpdateTime | String | Yes | Group update time |
Task group action
Used by actions: DescribeTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| TemplateGroupActionId | Integer | Yes | Template library group action ID |
| ActionId | Integer | Yes | Action ID |
| Order | Integer | Yes | Order of actions in the group |
| GeneralConfiguration | String | Yes | General configurations of actions in the group Note: This field may return null, indicating that no valid values can be obtained. |
| CustomConfiguration | String | Yes | Custom configurations of actions in the group Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Yes | Action group creation time |
| UpdateTime | String | Yes | Action group update time |
| ActionTitle | String | Yes | Action name |
| RandomId | Integer | Yes | Random ID Note: This field may return null, indicating that no valid values can be obtained. |
| RecoverId | Integer | Yes | Recovery action ID Note: This field may return null, indicating that no valid values can be obtained. |
| ExecuteId | Integer | Yes | Executed action ID Note: This field may return null, indicating that no valid values can be obtained. |
| ActionApiType | Integer | No | Called API type. 0: tat; 1: cloud API. Note: This field may return null, indicating that no valid values can be obtained. |
| ActionAttribute | Integer | No | 1: fault; 2: recovery. Note: This field may return null, indicating that no valid values can be obtained. |
| ActionType | String | No | Action type: platform and custom Note: This field may return null, indicating that no valid values can be obtained. |
| ActionRisk | String | No | Action risk level. 1: low-risk; 2: medium-risk; 3: high-risk. Note: This field may return null, indicating that no valid values can be obtained. |
Template library list information
Used by actions: DescribeTemplateList.
| Name | Type | Description |
|---|---|---|
| TemplateId | Integer | Template library ID |
| TemplateTitle | String | Template library name |
| TemplateDescription | String | Template library description |
| TemplateTag | String | Template library tag Note: This field may return null, indicating that no valid values can be obtained. |
| TemplateIsUsed | Integer | Template library status. 1: in use; 2: not in use. |
| TemplateCreateTime | String | Template library creation time |
| TemplateUpdateTime | String | Template library update time |
| TemplateUsedNum | Integer | Number of tasks associated with the template library |
| TemplateSource | Integer | Template library source. 0: self-built; 1: recommended by experts. Note: This field may return null, indicating that no valid values can be obtained. |
Monitoring metrics
Used by actions: DescribeTemplate.
| Name | Type | Description |
|---|---|---|
| MonitorId | Integer | pk |
| MetricId | Integer | Monitoring metric ID Note: This field may return null, indicating that no valid values can be obtained. |
| ObjectTypeId | Integer | Object type ID of the monitoring metric |
| MetricName | String | Metric name |
| MetricChineseName | String | Metric in Chinese Note: This field may return null, indicating that no valid values can be obtained. |
Protection policy
Used by actions: DescribeTemplate.
| Name | Type | Description |
|---|---|---|
| TemplatePolicyIdList | Array of String | Protection policy ID list |
| TemplatePolicyRule | String | Policy rules |
| TemplatePolicyDealType | Integer | Process method when the guardrail policy takes effect. 1: sequential execution, 2: pausing. |
フィードバック