Authorizing Scheduled Events
Function
Specifies the authorization of a scheduled event.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
POST /v1/{project_id}/scheduled-events/{event_id}/accept
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition: User project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A |
| event_id | Yes | String | Definition: Scheduled event ID. The value is the event_id field in the API for querying the scheduled event list. Constraints: N/A Range: The value is automatically generated by the system. It must start with a lowercase letter and cannot end with a hyphen (-). The value can contain at most 63 characters. Digits and hyphens (-) are allowed. Default Value: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| workspaceId | No | String | Definition: Workspace ID. The default value is 0. The value is the id field in the API for obtaining the workspace list. Constraints: The value is automatically generated by the system. It must start with a lowercase letter and cannot end with a hyphen (-). The value can contain at most 63 characters. Only lowercase letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| notBefore | No | String | Definition: Planned start time of an event, in the format of yyyy-MM-ddTHH:mm:ssZ. Constraints: N/A Range: later than the current time. Default Value: If this parameter is left empty, the event is executed immediately. |
| redeployConfig | No | redeployConfig object | Definition: Redeployment execution configuration. This parameter is available only for system maintenance, local disk recovery, or supernode redeployment. For other scheduled events, like node restart, O&M authorization, supernode maintenance, and supernode local disk recovery, you cannot configure redeployConfig. Constraints: Lite Server system maintenance and local disk recovery do not require configuration of the redeployment type. The SOFT and HARD modes are not distinguished. |
| instanceId | No | Array of strings | Definition: IDs of authorization nodes. This parameter is optional for redeployment authorization. You can enter the ID of a single faulty node. Constraints: N/A Range: List of faulty nodes in the scheduled event. Default Value: If this parameter is left blank, all nodes are authorized. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | No | String | Redeployment type of a node. If the node is unavailable, you can only use the hard mode. Hard mode resets the node, causing all data on the local and cloud disks to be lost. Exercise with caution. |
| autoFlow | No | Boolean | Silent repair switch. When the autoFlow switch is enabled, if redeployment fails, the system automatically proceeds to system maintenance or initiates a second redeployment. This process is automatically authorized and does not require additional authorization. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Definition: Request ID for task tracing. The format is **request_uuid - [/topic/body/section/table/tgroup/tbody/row/entry/p/b/br {""}) (br] - **[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| id | String | Event ID. |
| catalog | String | Definition: Event category. Range: N/A |
| isHyperNode | String | Definition: Supernode ID. Range: true or false |
| type | String | Definition: Event type. Range: |
| description | String | Description. |
| state | String | Definition: Event status. Range |
| publishTime | String | Definition: Event release time. Range: N/A |
| startTime | String | Definition: Event start time. Range: N/A |
| finishTime | String | Definition: Event completion time. Range: N/A |
| notBefore | String | Definition: Planned start time of the event, in UTC time string format, for example, 2025-09-15T07:02:30Z. Range: N/A |
| probeMsg | String | Definition: Prompt information. Range: N/A |
| executeOptions | ExecuteOptions object | Definition: Execution option. Range: N/A |
| redeployType | Array of strings | Definition: Node redeployment type list, indicating the redeployment types supported by the scheduled event. Range |
| autoRecoveryCheckTime | String | Definition: Time when the event is automatically authorized by the system. The value is a UTC time string, for example, 2025-09-15T07:02:30Z. Range: N/A |
| nodes | Array of NodeEvent objects | Definition: List of information about nodes associated with the event. Range: N/A |
| instanceId | String | Definition: Node ID. Instance ID automatically generated by the compute service system. The length of the ID is fewer than 63 characters. Range: N/A |
| nodeName | String | Definition: Node name, which is the value of metadata.name in the node details. The value is automatically generated by the system. It must start with a lowercase letter and consist of digits and hyphens (-). It cannot end with a hyphen (-) and can contain no more than 63 characters. Range: N/A |
| instanceType | String | Definition: Node type. Range: |
| underLyingInstanceId | String | Definition: ID of the ECS in the supernode scenario. Instance ID automatically generated by the compute service system. The length of the ID is fewer than 63 characters. Range: This parameter is involved in supernodes and is not involved in snt9b. |
| flavorSupportRedeploy | Boolean | Definition: Whether the flavor supports redeployment. Range: true or false |
| poolName | String | Definition: Name of the resource pool. This parameter is only available for lite-cluster and standard. The value is obtained from the metadata.name field in resource pool details. The value is automatically generated by the system. It must start with a lowercase letter and consist of digits and hyphens (-). It cannot end with a hyphen (-) and can contain no more than 63 characters. Range: N/A |
| poolDisplayName | String | Definition: Name of the resource pool displayed externally. This parameter is only available for lite-cluster and standard. The value is obtained from the metadata.labels field in resource pool details. The value can contain 36 to 63 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Digits and hyphens (-) are allowed. Range: N/A |
| jobProgress | String | Definition: Real-time progress of the redeployment execution, which is automatically generated by the system. Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| eventId | String | Definition: ID of an IaaS scheduled event. Range: N/A |
| isFaultNode | Boolean | Definition: Whether the node is faulty. Range: N/A |
| nodeName | String | Definition: Node name. Range: N/A |
| instanceId | String | Definition: Node ID. Range: N/A |
| instanceType | String | Definition: Instance type. Range: N/A |
| underLyingInstanceId | String | Definition: Underlying instance ID. Range: N/A |
| flavorSupportRedeploy | Boolean | Definition: Whether the node flavor supports redeployment. Range: N/A |
| poolName | String | Definition: Resource pool name. Range: N/A |
| poolDisplayName | String | Definition: Display name of a resource pool. Range: N/A |
| state | String | Definition: Status of an IaaS scheduled event. Range: N/A |
| publishTime | String | Definition: Time when an IaaS event was published. Range: N/A |
| startTime | String | Definition: IaaS event start time. Range: N/A |
| finishTime | String | Definition: Time when an IaaS event was completed. Range: N/A |
| jobProgress | String | Definition: Redeployment progress. Range: N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Definition: Request ID for task tracing. The format is **request_uuid - [/topic/body/section/table/tgroup/tbody/row/entry/p/b/br {""}) (br] - **[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
POST https://{endpoint}/v1/{project_id}/scheduled-events/{event_id}/accept
{
"notBefore" : "2025-09-15T07:02:30Z",
"redeployConfig" : {
"type" : "SOFT",
"autoFlow" : true
},
"instanceId" : [ "string" ]
} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | Event details. |
| 400 | Error response |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot