Bind Alert Template - BindAlarmTemplate
Overview
Bind Alert Template
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is BindAlarmTemplate. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| Zone | string | Availability Zone, the following resource types are not required: 'eip', 'sharebandwidth', 'ulb', 'ulb-vserver', 'ulb-server', 'vserver', 'ugc', 'upath', 'ugaa'. | No |
| ProjectId | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface. | No |
| AlarmTemplateId | string | Alarm template id, obtained by calling GetAlarmTemplateList | Yes |
| ResourceType | string | Resource type, same as the type supported by DescribeResourceMetric, please refer to the optional resource types in DescribeResourceMetric. | Yes |
| ResourceId.N | string | Short Resource ID List | Yes |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=BindAlarmTemplate
&ProjectId=org-xxx
&Zone=cn-bj2-02
&Region= cn-bj2
&AlarmTemplateId=xxxx
&ResourceType=uhost
&ResourceId.0=uhost-xxxxxResponse Example
{
"Action": "BindAlarmTemplateResponse",
"RetCode": 0
}