DescribeVpcFirewallZone API Reference - Cloud Firewall - Alibaba Cloud - Cloud Firewall

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

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
MemberUid	string	No	The UID of the Cloud Firewall member accounts.	135809047715****
RegionNo	string	No	The region ID.	cn-beijing
Lang	string	No	The language type. Valid values: en : English. zh : Chinese.	zh
Environment	string	No	The environment. Valid values: TransitRouter : Used for CEN Transit Router Enterprise Edition. VPC : Used for CEN Basic Edition.	TransitRouter
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance.	cen-4xbjup276au29r****
TransitRouterId	string	No	The transit router instance ID.	tr-m5etmb2q7e0mxcur****
SourceIp	string	No	The source IP address of the request.	222.212.86.7XXX

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	337A4DBA-8A01-5E9C-99CA-84293E13****
ZoneList	array<object>	The list of zones.
	array<object>	The list of zones.
	object	The zone.
ZoneId	string	The zone ID.	cn-hangzhou-c
LocalName	string	The zone name.	Hangzhou Zone C
FirewallServiceMode	string	The deployment mode of the virtual private cloud (VPC) firewall service. Valid values: PrimaryStandby: active/standby mode. MultiPrimary: active-active mode.	PrimaryStandby

Examples

Success response

JSON format

{
  "RequestId": "337A4DBA-8A01-5E9C-99CA-84293E13****",
  "ZoneList": [
    [
      {
        "ZoneId": "cn-hangzhou-c",
        "LocalName": "Hangzhou Zone C"
      }
    ]
  ],
  "FirewallServiceMode": "PrimaryStandby"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorRegionNoError	Region is error, please reselect	The specified region is invalid. Enter another value.
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorInvalidMemberUid	Member uid is invalid	The member is invalid.
400	ErrorParameters	A parameter error occurred.	A parameter error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.