UpdateRspDomainServerProhibitStatusForGateway - Alibaba Cloud DNS

Updates the server-side status of a domain name.

Operation description

Request 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:UpdateRspDomainServerProhibitStatusForGateway

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	Yes	A parameter that ensures idempotence.	asdf
DomainName	string	Yes	The domain name whose serverHold status you want to change.	example.com
AddStatusList	array<object>	No	A collection of domain name statuses to add.
	object	No	A collection of domain name statuses to add.
Status	string	No	The domain name status.	serverDeleteProhibited
StatusMsg	string	No	The description of the status.	实名认证未通过，增加serverUpdateProhibited状态
DeleteStatusList	array<object>	No	A collection of domain name statuses to delete.
	object	No	A collection of domain name statuses to delete.
Status	string	No	The domain name status.	serverDeleteProhibited
StatusMsg	string	No	The description of the status.	实名认证通过，删除serverUpdateProhibited状态

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The unique ID of the request.	0629502C-6224-5DC9-A8ED-2ED73A2E3931
Success	boolean	Indicates whether the request was successful. `true`: The request was successful. `false`: The request failed.	true
RecoverableError	boolean	Indicates whether the request can be retried if it fails. `true`: The request can be retried. `false`: The request cannot be retried.	true
Data	object	The returned data.
DomainName	string	The domain name.	example.com
StatusList	array<object>	The status information of the task.
	object	The status information of the task.
DomainName	string	The domain name.	uptp.test.abchina.com.cn
Status	string	The current status of the domain name.	serverUpdateProhibited
StatusMsg	string	The message for the domain name status.	实名认证未通过，增加serverUpdateProhibited状态
AccessDeniedDetail	object	The details about the access denial. This field is returned only when Resource Access Management (RAM) authentication fails.
AuthAction	string	The unauthorized operation that was attempted.	UpdateRspDomainServerProhibitStatusForGateway
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 encrypted complete diagnostic information.	AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==
NoPermissionType	string	The reason why authentication 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-6224-5DC9-A8ED-2ED73A2E3931",
  "Success": true,
  "RecoverableError": true,
  "Data": {
    "DomainName": "example.com",
    "StatusList": [
      {
        "DomainName": "uptp.test.abchina.com.cn",
        "Status": "serverUpdateProhibited",
        "StatusMsg": "实名认证未通过，增加serverUpdateProhibited状态"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "UpdateRspDomainServerProhibitStatusForGateway",
    "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.