CreateDNSServiceRule-阿里云帮助中心

Create a DNS authorization rule.

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

iotcc:CreateDNSServiceRule

create

*CloudConnector

acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}

None

Request parameters

Parameter	Type	Required	Description	Example
IoTCloudConnectorId	string	Yes	The ID of the cloud connector instance.	iotcc-1y6h8z7imd2yu4****
ServiceType	string	Yes	The target type of the DNS authorization rule. Valid values: Normal: Normal type. DNSRedirect: Redirection type. This type redirects the current DNS service endpoint to another endpoint.	Normal
Destination	string	No	The DNS service endpoint after redirection. Note This parameter is required when the ServiceType parameter is set to DNSRedirect.	192.168.0.2
Source	string	Yes	The source DNS IP address. Valid values: 100.100.2.136, 100.100.2.137, 100.100.2.138, 114.114.114.114, 8.8.8.8, 8.8.4.4, 223.5.5.5, 223.6.6.6, 221.5.88.88, 116.116.116.116, 221.228.15.26, 61.139.2.69, 218.6.200.139, 119.29.29.29, 218.2.2.2, 208.67.220.220, 208.67.222.222, 218.4.4.4. If you need other DNS authorization rule IP addresses beyond the default ones listed, submit a ticket and include the requested DNS authorization rule IP addresses in the ticket.	100.100.2.138
DNSServiceRuleName	string	No	The name of the DNS authorization rule. The name must be 2 to 128 characters in length. It must start with an English letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	test
DNSServiceRuleDescription	string	No	The description of the DNS authorization rule. The description must be 2 to 256 characters in length. It must start with an English letter or a Chinese character, but cannot start with `http://` or `https://`.	description
ClientToken	string	No	The client token ensures the idempotence of the request. Generate a parameter value from your client to ensure that the parameter value is unique among different requests. ClientToken supports only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Check the request without creating the DNS authorization rule. Valid values: true: Send a check request. The DNS authorization rule is not created. The system checks for required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the `DryRunOperation` error code is returned. false (default value): Send a normal request. After the check passes, an HTTP 2xx status code is returned, and the DNS authorization rule is created.	false
RegionId	string	Yes	The ID of the region where the DNS authorization rule is located. For more information, see ListRegions to query region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BC6D1C1D-6DBD-568C-B867-BC9CA699ED01
DNSServiceRuleId	string	The ID of the DNS authorization rule.	ar-r56ijpurlu50gi****

Examples

Success response

JSON format

{
  "RequestId": "BC6D1C1D-6DBD-568C-B867-BC9CA699ED01",
  "DNSServiceRuleId": "ar-r56ijpurlu50gi****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.RAM	Ram user does not have permission to perform this operation.	The error message returned because the RAM user does not have the permissions to perform the operation.
400	OperationDenied.DomainFeatureDisabled	The operation is not allowed because of domain feature disabled.
400	IllegalParam.Destination	The param of Destination is illegal.	The error message returned because the value of the Destination parameter is invalid.
400	ResourceAlreadyExist.AuthorizationRule	The specified resource of AuthorizationRule already exists.	The error message returned because the rule already exists.
400	Conflict.Param	The param is conflict.
400	Conflict.Cidr	The cidr is conflict.
400	ResourceNotFound.IoTCloudConnector	The param of IoTCloudConnectorId is illegal.	The error message returned because the value of the IoTCloudConnectorId parameter is invalid.
400	QuotaExceeded.sourceCidrLimit	The quota of SourceCidrsPerAuthorizationRule is exceeded
400	IllegalParam	The param is illegal.
400	QuotaExceeded.authorizationRuleInstanceLimit	The quota of AuthorizationRulePerIotCC is exceeded
400	IllegalParamFormat	The param is illegal.
400	ResourceInConfiguring.IoTCloudConnector	The specified resource of IoTCloudConnector is configuring, please try again later.
400	OperationDenied.CC5GInstanceNotSupport	The operation is not allowed because of CC5G instance not support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.