All Products
Search

This Product

    Cloud Firewall:DescribeSecurityProxy

    Document Center

    Cloud Firewall:DescribeSecurityProxy

    Last Updated:Jun 18, 2026

    Retrieves NAT firewall information.

    Note

    This API has been deprecated. We recommend migrating to Cloudfw(2017-12-07) - DescribeNatFirewallList for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language type for the request and response messages. Valid values:

    • zh (default): Chinese.

    • en: English.

    zh
    Lang

    string

    No

    请求和接收消息的语言类型。取值：

    • zh（默认）：中文。

    • en：英文。

    zh
    ProxyId

    string

    No

    The ID of the NAT firewall.

    proxy-nat80d763eb0dee4eacaec9
    ProxyName

    string

    No

    The name of the NAT firewall. The name can contain uppercase and lowercase letters, Chinese characters, digits, and underscores (_). The name must be 4 to 50 characters in length and cannot start with an underscore.

    nat-idmp-fir
    RegionNo

    string

    No

    The region ID of the VPC.

    cn-hangzhou
    VpcId

    string

    No

    The VPC-connected instance ID.

    vpc-8vbwbo90rq0anm6t****
    NatGatewayId

    string

    No

    The ID of the NAT gateway.

    ngw-zm0h3c1exm5bifuorg8c5
    Status

    string

    No

    The status of Cloud Firewall. Valid values:

    • configuring: Being created.

    • deleting: Being deleted.

    • normal: Normal.

    • abnormal: Abnormal.

    • opening: Being enabled.

    • closing: Being disabled.

    • closed: Disabled.

    normal
    PageNo

    string

    No

    The page number of the current page.

    1
    PageSize

    string

    No

    The maximum number of entries per page in a paged query. Maximum value: 50.

    10
    MemberUid

    string

    No

    The UID of the member accounts of the current Alibaba Cloud account.

    258039427902****

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of entries.

    5
    RequestId

    string

    The request ID.

    F0F82705-CFC7-5F83-86C8-A063892F****
    ProxyList

    array<object>

    The list of NAT firewalls.

    object

    The NAT firewall list information.

    VpcId

    string

    The VPC-connected instance ID.

    vpc-wz9xn35tq33hunzvpu0se
    Status

    string

    The status of Cloud Firewall. Valid values:

    • configuring: Being created.

    • deleting: Being deleted.

    • normal: Normal.

    • abnormal: Abnormal.

    • opening: Being enabled.

    • closing: Being disabled.

    • closed: Disabled.

    normal
    RegionNo

    string

    The region ID of the VPC.

    ap-southeast-1
    NatGatewayName

    string

    The name of the NAT gateway.

    ecs-slb-eip-waf
    MemberUid

    string

    The UID of the Cloud Firewall member accounts.

    1797733170015112
    ProxyId

    string

    The ID of the NAT firewall.

    proxy-nat4921f192b6cf438d93f8
    ProxyName

    string

    The name of the NAT firewall.

    nat-idmp-fir
    VpcName

    string

    The name of the VPC instance.

    vpc-bp1kw9igsq0yyzeanqamx
    VSwitchId

    string

    The ID of the vSwitch to which the Cloud Firewall interface belongs.

    vsw-5gu2qqfmjmwl8ktzgfekl
    CidrBlock

    string

    The IPv4 CIDR block of the VPC.

    192.168.0.0/16
    NatGatewayId

    string

    The ID of the NAT gateway.

    ngw-2zex8sf4s5vus8rq3rjqo
    Detail

    string

    The error details.

    “”
    SnatIpList

    array

    The list of SNAT IP addresses.

    string

    The list of SNAT IP addresses.

    ""
    StrictMode

    integer

    Indicates whether strict mode is enabled. Valid values:

    • 1: Strict mode is enabled.

    • 0: Strict mode is disabled.

    0

    Examples

    Success response

    JSON format

    {
  "TotalCount": 5,
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "ProxyList": [
    {
      "VpcId": "vpc-wz9xn35tq33hunzvpu0se",
      "Status": "normal",
      "RegionNo": "ap-southeast-1",
      "NatGatewayName": "ecs-slb-eip-waf",
      "MemberUid": "1797733170015112",
      "ProxyId": "proxy-nat4921f192b6cf438d93f8",
      "ProxyName": "nat-idmp-fir",
      "VpcName": "vpc-bp1kw9igsq0yyzeanqamx",
      "VSwitchId": "vsw-5gu2qqfmjmwl8ktzgfekl",
      "CidrBlock": "192.168.0.0/16",
      "NatGatewayId": "ngw-2zex8sf4s5vus8rq3rjqo",
      "Detail": "“”",
      "SnatIpList": [
        "\"\""
      ],
      "StrictMode": 0
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorAliUid Aliuid invalid. The aliuid 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 ErrorMarshalJSON internal error. Internal error.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.