ListDNSServiceRules-阿里云帮助中心

List DNS authorization rules.

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:ListDNSServiceRules

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IoTCloudConnectorId	string	Yes	ID of the cloud connector instance.	iotcc-1y6h8z7imd2yu4****
DNSServiceRuleIds	array	No	IDs of DNS authorization rules.
	string	No	ID of a DNS authorization rule. You can specify up to 20 rule IDs.	ar-c1dk4jb73j5791****
ServiceType	string	No	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	array	No	IP addresses of destination DNS authorization rules.
	string	No	Redirected DNS service endpoint. You can specify up to 20 destination IP addresses. Note This parameter is required when ServiceType is set to DNSRedirect.	192.168.0.2
DNSServiceRuleStatus	array	No	Status of the DNS authorization rule.
	string	No	Status of the DNS authorization rule. You can specify up to 20 statuses. Valid values: Creating: creating. Created: created. Deleting: deleting. Updating: updating.	Created
DNSServiceRuleName	array	No	Names of DNS authorization rules. You can specify up to 20 rule names.
	string	No	Name of a DNS authorization rule. You can specify up to 20 rule names. The name must be 2 to 128 characters in length and start with an English letter or Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-).	test
Source	array	No	IP addresses of source DNS authorization rules.
	string	No	Source DNS IP address. You can specify up to 20 source IP addresses. Examples include the following: 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, and 218.4.4.4. If you need other DNS IP addresses beyond this list, submit a ticket. Include the required DNS IP addresses in your ticket.	100.100.2.138
NextToken	string	No	Token for the next query. Valid values: Omit this parameter for the first query or if no more results are available. For subsequent queries, use the NextToken value returned by the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	Maximum number of entries to return per page. Valid values: 1 to 50. Default value: 10.	10
RegionId	string	Yes	ID of the region where the cloud connector instance resides. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Request ID.
RequestId	string	Request ID.	4A63118E-B375-5718-8F03-30F6804E1DCD
TotalCount	integer	Total number of entries in the list.	10
NextToken	string	Token for the next query. Valid values: If NextToken is empty, no more results are available. If NextToken has a value, it is the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Maximum number of entries to return per page.	10
DNSServiceRules	array<object>	List of DNS authorization rules.
	object	List of DNS authorization rules.
IoTCloudConnectorId	string	ID of the cloud connector instance.	iotcc-1y6h8z7imd2yu4****
ServiceType	string	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
Source	string	Source DNS IP address. Examples include the following: 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, and 218.4.4.4. If you need other DNS IP addresses beyond this list, submit a ticket. Include the required DNS IP addresses in your ticket.	100.100.2.138
Destination	string	Redirected DNS service endpoint. Note This parameter is required when ServiceType is set to DNSRedirect.	192.168.0.2
DNSServiceRuleStatus	string	Status of the DNS authorization rule. Valid values: Creating: creating. Created: created. Deleting: deleting. Updating: updating.	Created
DNSServiceRuleName	string	Name of the DNS authorization rule. The name must be 2 to 128 characters in length and start with an English letter or Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-).	test
DNSServiceRuleDescription	string	Description of the DNS authorization rule. The description must be 2 to 256 characters in length and start with an English letter or Chinese character. It cannot start with `http://` or `https://`.	description
DNSServiceRuleId	string	ID of the DNS authorization rule.	ar-c1dk4jb73j5791****

Examples

Success response

JSON format

{
  "RequestId": "4A63118E-B375-5718-8F03-30F6804E1DCD",
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 10,
  "DNSServiceRules": [
    {
      "IoTCloudConnectorId": "iotcc-1y6h8z7imd2yu4****",
      "ServiceType": "Normal",
      "Source": "100.100.2.138",
      "Destination": "192.168.0.2",
      "DNSServiceRuleStatus": "Created",
      "DNSServiceRuleName": "test",
      "DNSServiceRuleDescription": "description",
      "DNSServiceRuleId": "ar-c1dk4jb73j5791****"
    }
  ]
}

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	ResourceNotFound.IoTCloudConnector	The param of IoTCloudConnectorId is illegal.	The error message returned because the value of the IoTCloudConnectorId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.