AddRspDomainServerHoldStatusForGateway - Alibaba Cloud DNS

Adds the serverHold status to a specified domain name.

Operation description

Request description

This API adds the serverHold property to 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:AddRspDomainServerHoldStatusForGateway

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	Yes	An idempotency parameter.	token123
DomainName	string	Yes	The domain name.	dns-example.top
StatusMsg	string	Yes	The status description.	Authentication passed. Unlock serverHold

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique ID of the request.	0629502C-XXXX-5DC9-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. A value of `false` indicates that you cannot.	true
Data	object	The returned data list.
DomainName	string	The domain name.	example.com
AccessDeniedDetail	object	The details about the access denial. This field is returned only when Resource Access Management (RAM) verification fails.
AuthAction	string	The unauthorized operation that was attempted.	AddRspDomainServerHoldStatusForGateway
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 identity type.	SubUser
EncodedDiagnosticMessage	string	The complete diagnostic information after encryption.	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-5DC9-XXXX-2ED73A2E3931",
  "Success": true,
  "RecoverableError": true,
  "Data": {
    "DomainName": "example.com"
  },
  "AccessDeniedDetail": {
    "AuthAction": "AddRspDomainServerHoldStatusForGateway",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "1046973331XXXX",
    "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.