All Products
Search

This Product

    Cloud Firewall:DescribeOutgoingDestinationCategory

    Document Center

    Cloud Firewall:DescribeOutgoingDestinationCategory

    Last Updated:Jul 31, 2026

    Queries the destination categories of outbound connections.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SourceIp deprecated

    string

    No

    The source IP address of the request.

    59.82.45.XXX
    Lang

    string

    No

    The language type of the response message.

    zh
    StartTime

    string

    Yes

    The start time of the query. The value is a UNIX timestamp in seconds.

    1749657600
    EndTime

    string

    Yes

    The end time of the query. The value is a UNIX timestamp in seconds.

    1750818370
    CategoryId

    string

    No

    The destination category ID. In addition to All, RiskDomain, AliYun, and NotAliYun, the NotAliYun category also includes subcategories such as TrustedDomain, AliPay, DingDing, WeChat, Google, Alibaba, CDN, NAT, and TrustIP. More than 25 category values are supported. Use the categories returned by the API as the reference.

    Valid values:

    • All :

      all.

    • RiskDomain :

      risk domain names.

    • AliYun :

      Alibaba Cloud products.

    • NotAliYun :

      non-Alibaba Cloud products.

    All
    TypeId

    string

    No

    The fixed category ID.

    Valid values:

    • All :

      all.

    • AliYun :

      Alibaba Cloud products.

    • NotAliYun :

      non-Alibaba Cloud products.

    All
    DstType

    string

    No

    The destination type. This parameter is required. If this parameter is not specified, ErrorDstType is returned. The value is case-sensitive. Valid values:

    • Domain: domain name.

    • DstIP: destination IP address.

    Valid values:

    • DstIP :

      destination IP address.

    • Domain :

      domain name.

    Domain

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of entries.

    10
    RequestId

    string

    The request ID.

    C1ED80BC-FFC8-57DB-8151-705DC31****
    TypeList

    array<object>

    The list of outbound connections categorizations.

    array<object>

    The outbound connections categorization.

    TypeName

    string

    The fixed category name.

    AliYun
    TypeId

    string

    The fixed category ID.

    Valid values:

    • All :

      all.

    • AliYun :

      Alibaba Cloud products.

    • NotAliYun :

      non-Alibaba Cloud products.

    All
    TypeDescribe

    string

    The fixed category description.

    AliYun
    CategoryList

    array<object>

    The list of outbound connections categorizations.

    object

    The outbound connections categorization.

    CategoryId

    string

    The outbound connections categorization ID.

    123
    CategoryName

    string

    The outbound connections categorization name.

    AliYun
    CategoryDescribe

    string

    The outbound connections categorization description.

    AliYun
    ClassId

    string

    The outbound connections categorization level ID.

    Trusted

    Examples

    Success response

    JSON format

    {
  "TotalCount": 10,
  "RequestId": "C1ED80BC-FFC8-57DB-8151-705DC31****",
  "TypeList": [
    {
      "TypeName": "AliYun",
      "TypeId": "All",
      "TypeDescribe": "AliYun",
      "CategoryList": [
        {
          "CategoryId": "123",
          "CategoryName": "AliYun",
          "CategoryDescribe": "AliYun",
          "ClassId": "Trusted"
        }
      ]
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
    400 ErrorDstType The dst type is invalid. The destination type is invalid.
    400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
    400 ErrorObjectOperation The objectOperation is invalid. The objectOperation is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.