UpdateGatewayMaintenancePeriod-阿里云帮助中心

Operation description

Modifies the O&M time window of a gateway. This feature is supported only by specific gateway types. If the current gateway does not support modifying the O&M time window, the API returns 409 Conflict.GatewayNotSupportAutoMaintenance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:UpdateGatewayMaintenancePeriod

none

*Gateway

acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}

None

Request syntax

POST /v1/gateways/{gatewayId}/maintenance-period HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
gatewayId	string	No	The gateway ID.	gw-xxxx

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
maintenancePeriod	object	No	The O&M window.
endTime	string	No	The O&M end time (HH:mm).	02:00
startTime	string	No	The O&M start time (HH:mm).	02:00

Response elements

Element	Type	Description	Example
	object	The response struct.
code	string	The response status code.	200
message	string	The response message.	success
requestId	string	The request ID.	8FA817D1-CCB0-5776-A604-8FC5DE6DACB9

Examples

Success response

JSON format

{
  "code": "200",
  "message": "success",
  "requestId": "8FA817D1-CCB0-5776-A604-8FC5DE6DACB9"
}

Error codes

HTTP status code	Error code	Error message	Description
409	Conflict.GatewayNotSupportAutoMaintenance	Auto maintenance is not supported for this gateway.	The gateway does not support automatic maintenance time window configuration.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.