Restore Domain Availability by Releasing serverHold with RSP Gateway API - Alibaba Cloud DNS - Alibaba Cloud - Alibaba Cloud DNS

Removes the serverHold status of a specified domain name.

Operation description

Description

This operation removes the serverHold status of a specified domain name.

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

alidns:RemoveRspDomainServerHoldStatusForGateway

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	Yes	The client token that is used to ensure the idempotence of the request.	asdf
DomainName	string	Yes	The domain name.	example.com
StatusMsg	string	No	The description of the status.	实名认证通过，解除serverHold状态

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The unique ID of the request.	0629502C-6224-5DC9-A8ED-2ED73A2E3931
Success	boolean	Indicates whether the request succeeded. Valid values: `true` (succeeded) and `false` (failed).	true
RecoverableError	boolean	Indicates whether you can retry the request if it fails. Valid values: `true` (retry allowed) and `false` (retry not allowed).	true
Data	object	The returned data.
DomainName	string	The domain name.	example.com
ServerHoldStatus	string	The domain's serverHold status.	enable
AccessDeniedDetail	object	Details about the access denial. This field appears only when Resource Access Management (RAM) authentication fails.
AuthAction	string	The unauthorized operation that was attempted.	RemoveRspDomainServerHoldStatusForGateway
AuthPrincipalDisplayName	string	The display name of the authorized entity.	2015555733387XXXX
AuthPrincipalOwnerId	string	The ID of the owner of the authorized entity.	10469733312XXX
AuthPrincipalType	string	The identity type.	SubUser
EncodedDiagnosticMessage	string	The complete diagnostic information after encryption.	AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==
NoPermissionType	string	The reason why authorization failed. Valid values: ExplicitDeny: Access is explicitly denied. ImplicitDeny: Access is implicitly denied.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.