ModifyGateway-阿里云帮助中心

Call this API to modify the basic information of a gateway, including the gateway name and gateway description.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
GatewayName	string	Yes	The gateway name.	test
GatewayDesc	string	No	The gateway description.	DG_Test
GatewayId	string	Yes	The gateway ID.	dg-nmz841r7b681****

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	200
Data	string	The result of the operation.	SUCCESS
ErrorMsg	string	The error message.	Gateway exception, please launch local dg first
RequestId	string	The request ID. You can use this ID to trace logs and troubleshoot issues.	18071187-5EA1-5DD4-AAD9-F27C5713CD1C
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
AccessDeniedDetail	object	Details of the request failure.
AuthAction	string	The API operation that was performed.	dms-dg:ModifyGateway
AuthPrincipalDisplayName	string	The display name of the authentication principal.	23894333884425****
AuthPrincipalOwnerId	string	The owner ID of the authentication principal.	1218522260143***
AuthPrincipalType	string	The type of the authentication principal.	SubUser
EncodedDiagnosticMessage	string	The complete encoded diagnostic message.	AQEAAAAAaQQYWjRDMkY1NjE1LTQwRDMtNTIyOS1BQjg0LTg0NDE0OTVCNTIwOA==
NoPermissionType	string	The reason for the authentication failure.	ExplicitDeny
PolicyType	string	The type of policy that caused the authentication failure.	COST_OPTIMIZED

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": "SUCCESS",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "18071187-5EA1-5DD4-AAD9-F27C5713CD1C",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "dms-dg:ModifyGateway",
    "AuthPrincipalDisplayName": "23894333884425****",
    "AuthPrincipalOwnerId": "1218522260143***",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaQQYWjRDMkY1NjE1LTQwRDMtNTIyOS1BQjg0LTg0NDE0OTVCNTIwOA==",
    "NoPermissionType": "ExplicitDeny",
    "PolicyType": "COST_OPTIMIZED"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.