UpdateRspDomainServerProhibitStatusForGatewayOte - Alibaba Cloud DNS

Updates the server-side status of a domain name.

Operation description

This operation updates the server-side status of a 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:UpdateRspDomainServerProhibitStatusForGatewayOte

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	Yes	Idempotency token.	qwoefasdf
DomainName	string	Yes	Domain name.	example.com
AddStatusList	array<object>	No	List of domain name statuses to add.
	object	No	The collection of domain statuses to add.
Status	string	No	Domain name status.	serverDeleteProhibited
StatusMsg	string	No	Description of the status.	Authentication failed. Add serverUpdateProhibited status
DeleteStatusList	array<object>	No	List of domain name statuses to remove.
	object	No	The collection of domain statuses to delete.
Status	string	No	Domain name status.	serverDeleteProhibited
StatusMsg	string	No	Description of the status.	Authentication passed. Delete serverUpdateProhibited status.

Response elements

Element	Type	Description	Example
	object	Response schema.
RequestId	string	Unique ID of the request.	0629502C-6224-5DC9-A8ED-2ED73A2E3931
Success	boolean	Indicates whether the request succeeded. `true`: succeeded. `false`: failed.	true
RecoverableError	boolean	Indicates whether you can retry the request after failure. `true`: retry is allowed. `false`: retry is not allowed.	true
Data	object	List of returned data items.
DomainName	string	Domain name.	example.com
StatusList	array<object>	Status information for the task
	object	Status information for the task
DomainName	string	Domain name.	example.com
Status	string	Current domain name status.	serverUpdateProhibited
StatusMsg	string	Description of the domain name status.	Add serverUpdateProhibited status
AccessDeniedDetail	object	Detailed access-denied information. This field appears only when RAM authentication fails.
AuthAction	string	The unauthorized operation that was attempted.	UpdateRspDomainServerProhibitStatusForGatewayOte
AuthPrincipalDisplayName	string	Display name of the authenticated entity.	2015555733387XXXX
AuthPrincipalOwnerId	string	Owner ID of the authenticated entity.	10469733312XXX
AuthPrincipalType	string	Identity type.	SubUser
EncodedDiagnosticMessage	string	Encrypted diagnostic message.	AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==
NoPermissionType	string	Reason for authentication failure. Valid values: ExplicitDeny ImplicitDeny	ImplicitDeny
PolicyType	string	Policy type.	DlpSend

Examples

Success response

JSON format

{
  "RequestId": "0629502C-6224-5DC9-A8ED-2ED73A2E3931",
  "Success": true,
  "RecoverableError": true,
  "Data": {
    "DomainName": "example.com",
    "StatusList": [
      {
        "DomainName": "example.com",
        "Status": "serverUpdateProhibited",
        "StatusMsg": "实名认证未通过，增加serverUpdateProhibited状态"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "UpdateRspDomainServerProhibitStatusForGatewayOte",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "10469733312XXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
    "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.