调用 CreateSubscription 接口，订阅系统事件通知。
注意事项
同一Type（订阅类型）仅支持使用本接口订阅一次事件通知。如需调整该Type订阅的EventTypes.N（事件类型），请调用ModifySubscriptionEventTypes接口，传入本接口返回的SubscriptionId（订阅ID）完成操作。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|
Action | String | 是 | | 要执行的操作，取值：CreateSubscription。 |
Version | String | 是 | | |
EventTypes.N | Array of String | 是 | EventTypes.1=SystemFailure.Stop:Succeeded&EventTypes.2=SystemFailure.Stop:Succeeded | 事件类型，最多支持100个。 - 参数 - N：表示事件类型的序号。
- 多个事件类型之间用&分隔。
- 取值：
- SystemFailure.Redeploy:Inquiring：系统故障，导致实例重新部署：待响应
- SystemFailure.Redeploy:Succeeded：系统故障，导致实例重新部署：执行成功
- SystemFailure.Stop:Succeeded:系统故障，导致实例停止：执行成功
- SystemFailure.Reboot:Succeeded：系统故障，导致实例重启：执行成功
- GpuError.Redeploy:Inquiring：GPU异常，导致实例重新部署：待响应
- GpuError.Redeploy:Succeeded：GPU异常，导致实例重新部署：执行成功
- SpotInstanceInterruption.Delete:Scheduled：抢占型实例中断，实例释放：计划执行
- SpotInstanceInterruption.Delete:Succeeded：抢占型实例中断，实例释放：执行成功
- AccountUnbalanced.Stop:Succeeded：账户欠费，实例停止：执行成功
- AccountUnbalanced.Delete:Succeeded：账户欠费，实例释放：执行成功
- FileSystemReadOnly.Change:Succeeded：文件系统变为只读状态：执行成功
- InstanceFailure:Succeeded：实例异常：执行成功
- SystemMaintenance.Redeploy:Inquiring：系统维护，实例重新部署：待响应
- SystemMaintenance.Redeploy:Succeeded：系统维护，实例重新部署：执行成功
- ServerMigrationTask:Executing：服务器迁移任务：执行中
- ServerMigrationTask:Pending：服务器迁移任务：已暂停
- ServerMigrationTask:Recovered：服务器迁移任务：已恢复
- ServerMigrationTask:Succeeded：服务器迁移任务：执行成功
- ServerMigrationTask:Failed：服务器迁移任务：执行失败
- ServerMigration.FirstSync:Succeeded：服务器迁移，全量数据同步：执行成功
- ServerMigration.FirstSync:Failed：服务器迁移，全量数据同步：执行失败
- ServerMigration.AdditionalSync:Succeeded：服务器迁移，增量数据同步：执行成功
- ServerMigration.AdditionalSync:Failed：服务器迁移，增量数据同步：执行失败
- GpuRiskDetected:Succeeded：GPU运行存在风险：执行成功
- DiskErrorDetected:Inquiring：硬盘异常：待响应
- DiskError.Redeploy:Inquiring：磁盘异常，实例重新部署：待响应
- DiskError.Redeploy:Succeeded：磁盘异常，实例重新部署：执行成功
- InstanceOOM:Succeeded：实例内存OOM：执行成功
|
Type | String | 是 | | 订阅类型，取值： - Notification：消息通知，通知渠道为短信、邮件、站内信、飞书。
|
返回参数
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|
SubscriptionId | String | | |
请求示例
GET /?Action=CreateSubscription&Version=2020-04-01&EventTypes.1=SystemFailure.Stop:Succeeded&EventTypes.2=SystemFailure.Stop:Succeeded&Type=Notification HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs
返回示例
{
"ResponseMetadata": {
"RequestId": "20210611144510010225243100005******",
"Action": "CreateSubscription",
"Version": "2020-04-01",
"Service": "ecs",
"Region": "cn-beijing"
},
"Result": {
"SubscriptionId": "s-4shu38sa4mjx******"
}
}
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
|---|
400 | InvalidArgument | The specified argument is invalid. | |
400 | InvalidEventTypes.Malformed | The specified EventTypes is malformed. | |
400 | InvalidType.Malformed | The specified Type is malformed. | |
400 | LimitExceeded.MaximumEventTypes | The number of specified EventTypes exceeds the maximum limit. | |
400 | LimitExceeded.MaximumSubscriptions | You've reached the limit on the number of subscriptions that you can create. | |
400 | MissingParameter.EventTypes | The required parameter EventTypes is not supplied. | |
400 | MissingParameter.Type | The required parameter Type is not supplied. | |
500 | InternalError | An internal error has occurred. | |