DescribeHybridCloudSdkServers - Web Application Firewall

Queries a list of hybrid cloud SDK servers.

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-waf:DescribeHybridCloudSdkServers

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the current WAF instance.	waf_v3prepaid_public_cn-i7m2***0b
Ip	string	No	The IP address of the device.	1..1。
HostName	string	No	The hostname.	online-***wwq
ClusterName	string	No	The name of the cluster.	测试集群。
PageSize	integer	No	The number of entries per page. The default value is 10.	10
PageNumber	integer	No	The page number of the list. The default value is 1.	1
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries.	5
SdkServers	array<object>	The SDK information.
	object
Status	string	The status.	1
PullinStatus	string	The traffic redirection status. Valid values: on: enabled off: disabled	on
ResourceId	string	The resource ID.	test-antifaud-2.jqt.wafqax.top-waf
Ip	string	The IP address.	127.0.0.1
CreateTime	integer	The UNIX timestamp when the resource was created.	1621428205000
UpdateTime	integer	The UNIX timestamp when the resource was last updated.	1719489906000
ClusterName	string	The name of the cluster.	集群名称
Mid	string	The SDK ID.	b11327c21790846374051d5d**83c
ProtectionGroupAddress	string	The IP address of the backend server.	1.1.1.1
HostName	string	The hostname.	qsh5-sec-8-fedd**005
RequestId	string	The request ID.	3600F008-2E76-5D0B-BC76-EFBD****6D

Examples

Success response

JSON format

{
  "TotalCount": 5,
  "SdkServers": [
    {
      "Status": "1",
      "PullinStatus": "on",
      "ResourceId": "test-antifaud-2.jqt.wafqax.top-waf",
      "Ip": "127.0.0.1",
      "CreateTime": 1621428205000,
      "UpdateTime": 1719489906000,
      "ClusterName": "集群名称",
      "Mid": "b11327c21790846374051d5d**83c",
      "ProtectionGroupAddress": "1.1.1.1",
      "HostName": "qsh5-sec-8-fedd**005"
    }
  ],
  "RequestId": "3600F008-2E76-5D0B-BC76-EFBD****6D"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.