DescribeConfiguredDomainNames-阿里云帮助中心

Lists the active outbound domain names.

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

yundun-cloudfirewall:DescribeConfiguredDomainNames

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address.	1.202.149.XXX
Lang	string	No	The language of the response. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the response. Valid values: en : English zh : Chinese	zh
DomainName	string	No	The domain name.	example.com
GroupName	string	Yes	The group name.	ignore
PageSize	string	No	The number of entries per page.	10
CurrentPage	string	No	The page number.	1
Direction	string	Yes	The traffic direction. Valid values: in : inbound out : outbound	out
SourceCode	string	Yes	The trace code.	yundun

Response elements

Element	Type	Description	Example
	object	The returned data.
Module	string	The application module.	sg_server
RequestId	string	The request ID.	09A2D6F1-EA1B-56D9-977D-74878405****
TotalCount	integer	The total number of entries.	16
DomainNames	array<object>	The list of domain names.
	object	The details of a domain name.
IsMalicious	boolean	Indicates whether the domain name is malicious. Valid values: `0` (not malicious) and `1` (malicious).	0
OperationTime	integer	The time of the operation, specified as a Unix timestamp in seconds. Example: `1672502400`.	1534408189
DomainName	string	The domain name.	example.com
Comment	string	The comment.	test

Examples

Success response

JSON format

{
  "Module": "sg_server",
  "RequestId": "09A2D6F1-EA1B-56D9-977D-74878405****",
  "TotalCount": 16,
  "DomainNames": [
    {
      "IsMalicious": true,
      "OperationTime": 1534408189,
      "DomainName": "example.com",
      "Comment": "test"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorSourceCodeError	The source code is invalid.	The source code is invalid.
400	ErrorObjectOperation	The objectOperation is invalid.	The objectOperation is invalid.
400	ErrorPageNo	Either page number or page size is invalid.	Either page number or page size is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorMarshalJSON	internal error.	Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.