All Products
Search

This Product

    Cloud Firewall:DescribeOutgoingDestinationIPDetail

    Document Center

    Cloud Firewall:DescribeOutgoingDestinationIPDetail

    Last Updated:Jan 07, 2026

    Retrieves the details of an outbound destination IP address.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SourceIp

    string

    No

    The source IP address.

    1.202.193.XXX
    Lang

    string

    No

    The language of the message.

    zh
    Lang

    string

    No

    The language of the message.

    zh
    StartTime

    string

    Yes

    The start of the time range to query. This value is a UNIX timestamp. Unit: seconds.

    1749434787
    EndTime

    string

    Yes

    The end of the time range to query. This value is a UNIX timestamp. Unit: seconds.

    1733710383
    PageSize

    string

    No

    The number of the page to return.

    10
    CurrentPage

    string

    No

    The number of the page to return.

    1
    TagId

    string

    No

    The tag ID.

    Valid values:

    • FirstFlow :

      The traffic is detected for the first time.

    • Period :

      The traffic is periodic.

    FirstFlow
    AclCoverage

    string

    No

    The policy coverage.

    Valid values:

    • All :

      All

    • FullCoverage :

      Covered

    • Uncovered :

      Not covered

    • PartialCoverage :

      Partially covered

    FullCoverage
    DstIP

    string

    Yes

    The destination IP address.

    34.136.111.XXX
    PublicIP

    string

    No

    The public IP address.

    192.0.XX.XX
    PrivateIP

    string

    No

    The private IP address.

    10.210.0.XXX
    Sort

    string

    No

    The field to use for sorting.

    Valid values:

    • InBytes :

      Inbound traffic

    • SessionCount :

      Number of sessions

    • OutBytes :

      Outbound traffic

    InBytes
    Order

    string

    No

    The sort order.

    Valid values:

    • asc :

      Ascending

    • desc :

      Descending

    desc
    IPType

    string

    No

    Queries outbound connections from a private network through a NAT gateway.

    NatPrivate
    NatGatewayId

    string

    No

    The ID of the NAT Gateway.

    ngw-2zed6z6qkd7ogc****

    Response elements

    Element

    Type

    Description

    Example

    object

    LocationName

    string

    The name of the region.

    杭州
    IspName

    string

    The carrier of the destination IP address.

    电信
    RequestId

    string

    The ID of the request.

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

    integer

    The total number of returned entries.

    25
    AssetList

    array<object>

    The list of assets.

    array<object>

    The list of assets.

    AclCoverage

    string

    The policy coverage.

    Valid values:

    • All :

      All

    • FullCoverage :

      Covered

    • Uncovered :

      Not covered

    • PartialCoverage :

      Partially covered

    FullCoverage
    ResourceInstanceName

    string

    The name of the asset instance.

    test
    ResourceInstanceId

    string

    The ID of the cloud service instance.

    i-uf63wjhyoohc1g4z****
    RegionNo

    string

    The region ID.

    cn-shanghai
    InBytes

    integer

    The inbound traffic. Unit: bytes.

    0.0
    LocationName

    string

    The region where the destination IP address is located.

    杭州
    FirstTime

    integer

    The time when the traffic was first detected.

    1744682438
    PrivateIP

    string

    The private IP address.

    10.21.242XXX
    RuleId

    string

    The rule ID.

    08a58465-ff4d-4c47-8782-eb008301****
    RuleName

    string

    The rule name.

    test
    SessionCount

    integer

    The number of sessions.

    2
    LastTime

    integer

    The time when the traffic was last detected.

    1739326614
    ResourceType

    string

    The type of the public IP address of the asset.

    Valid values:

    • EcsEIP :

      An EIP that is associated with an ECS instance.

    • EcsPublicIP :

      A public IP address of an ECS instance.

    • NatPublicIP :

      A public IP address of a NAT gateway.

    • NatEIP :

      An EIP that is associated with a NAT gateway.

    • EIP :

      An EIP.

    EcsPublicIP
    OutBytes

    integer

    The outbound traffic. Unit: bytes.

    0.0
    IspName

    string

    The carrier of the destination IP address.

    电信
    PublicIP

    string

    The public IP address.

    47.96.181.XXX
    TotalBytes

    string

    The total traffic.

    458681
    VpcId

    string

    The ID of the VPC instance.

    vpc-9dp16jgwgyvn****
    NatGatewayId

    string

    The ID of the NAT Gateway.

    ngw-bp1utx6wj4x9qu9tl****
    NatGatewayName

    string

    The name of the NAT Gateway.

    ngw-test
    TagList

    array<object>

    The list of tags.

    object

    The list of tags.

    RiskLevel

    integer

    The risk level.

    Valid values:

    • 0 :

      No risk

    • 1 :

      Low risk

    • 2 :

      Medium risk

    • 3 :

      High risk

    0
    TagName

    string

    The tag name.

    test
    TagId

    string

    The tag ID.

    FirstFlow
    TagDescribe

    string

    The tag description.

    test
    ClassId

    string

    The classification ID.

    1

    Examples

    Success response

    JSON format

    {
  "LocationName": "杭州",
  "IspName": "电信",
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "TotalCount": 25,
  "AssetList": [
    {
      "AclCoverage": "FullCoverage",
      "ResourceInstanceName": "test",
      "ResourceInstanceId": "i-uf63wjhyoohc1g4z****",
      "RegionNo": "cn-shanghai",
      "InBytes": 0,
      "LocationName": "杭州",
      "FirstTime": 1744682438,
      "PrivateIP": "10.21.242XXX",
      "RuleId": "08a58465-ff4d-4c47-8782-eb008301****",
      "RuleName": "test",
      "SessionCount": 2,
      "LastTime": 1739326614,
      "ResourceType": "EcsPublicIP",
      "OutBytes": 0,
      "IspName": "电信",
      "PublicIP": "47.96.181.XXX",
      "TotalBytes": "458681",
      "VpcId": "vpc-9dp16jgwgyvn****",
      "NatGatewayId": "ngw-bp1utx6wj4x9qu9tl****",
      "NatGatewayName": "ngw-test",
      "TagList": [
        {
          "RiskLevel": 0,
          "TagName": "test",
          "TagId": "FirstFlow",
          "TagDescribe": "test",
          "ClassId": "1"
        }
      ]
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
    400 ErrorTimeError The time is invalid. The time is invalid.
    400 ErrorIpFormat The IP address is invalid. The IP address is invalid.
    400 ErrorPortError The port is invalid. The port is invalid.
    400 ErrorSortError The sort is invalid. The sort is invalid.
    400 ErrorOrderFailed The order is invalid. The order is invalid.
    400 ErrorPageNo Either page number or page size is invalid. Either page number or page size is invalid.
    400 ErrorIntervalError The interval is invalid. The interval is invalid.
    400 ErrorDataTypeError The data type is invalid. The data type is invalid.
    400 ErrorMarshalJSON internal error. Internal error.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.