UpdateRspDomainServerHoldStatusOte - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Updates the serverHold status for a specific domain name.

Operation description

Request description

This API is intended for use by gateway users. It allows them to update the serverHold property of a specific domain name.
Specify the OperatorType, OperatorId, DomainName, ServerHoldStatus, and StatusMsg parameters to identify the domain name under a specific gateway, set its serverHold status, and provide the reason for the modification.

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
ClientToken	string	No	A client token to ensure idempotency.	443F1A21-XXXX-55C4-93E1-FF020DF93D7B
OperatorType	string	Yes	The operation type. The value is fixed to registryGateway. Valid values: registryGateway : registryGateway	registryGateway
OperatorId	string	Yes	The operation ID. This is the gateway ID.	gatewayId001
DomainName	string	Yes	The domain name whose serverHold status you want to modify.	example.com
ServerHoldStatus	string	Yes	Enable or disable the serverHold status for the domain name.	enable
StatusMsg	string	Yes	Identity verification failed. The serverHold status is added.	Authentication failed. Adds erverHold

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique ID of the request.	0629502C-XXXX-XXXX-XXXX-2ED73A2E3931
Success	boolean	Indicates whether the request was successful. A value of `true` indicates success. A value of `false` indicates failure.	true
RecoverableError	boolean	Indicates whether you can retry the request if it fails. A value of `true` indicates that you can retry the request. A value of `false` indicates that you cannot.	true
Data	object	The returned data.
DomainName	string	The domain name.	example.com
ServerHoldStatus	string	The updated serverHold status.	enable
AccessDeniedDetail	object	Details about the access denial. This field is returned only if the Resource Access Management (RAM) verification fails.
AuthAction	string	The unauthorized operation that was attempted.	CreateUser
AuthPrincipalDisplayName	string	The display name of the authorized entity.	2015555733387XXXX
AuthPrincipalOwnerId	string	The ID of the owner of the authorized entity.	1046973331XXXX
AuthPrincipalType	string	The type of identity.	SubUser
EncodedDiagnosticMessage	string	The encrypted complete diagnostic information.	AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==
NoPermissionType	string	The reason why the authorization failed. Valid values: ExplicitDeny: The access is explicitly denied. ImplicitDeny: The access is implicitly denied.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend

Examples

Success response

JSON format

{
  "RequestId": "0629502C-XXXX-XXXX-XXXX-2ED73A2E3931",
  "Success": true,
  "RecoverableError": true,
  "Data": {
    "DomainName": "example.com",
    "ServerHoldStatus": "enable"
  },
  "AccessDeniedDetail": {
    "AuthAction": "CreateUser",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "1046973331XXXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Alirs.Operator.NotAuthorized	The operator does not belong to the cloud account.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.