All Products
Search

This Product

    Cloud Firewall:DescribeSensitiveSwitch

    Document Center

    Cloud Firewall:DescribeSensitiveSwitch

    Last Updated:Nov 20, 2025

    Queries the status of the sensitive data detection switch.

    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
    Lang

    string

    No

    The language of the request and response.

    Valid values:

    • en :

      English

    • zh :

      Chinese

    zh
    ParentCategory

    string

    No

    The parent class.

    universal_industry_template
    SensitiveCategory

    string

    No

    The type of the sensitive credential.

    id_card
    CurrentPage

    integer

    No

    The number of the page to return.

    1
    PageSize

    integer

    No

    The number of the page to return.

    10
    CategoryName

    string

    No

    The name of the category.

    身份证
    SensitiveLevel

    string

    No

    The sensitivity level.

    S3
    SwitchStatus

    string

    No

    The status of the sensitive data detection switch.

    Valid values:

    • 0 :

      disabled

    • 1 :

      enabled

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The ID of the request.

    A7F3ED45-5556-5AF3-ADE3-EE48FFF0****
    TotalCount

    integer

    The total number of entries returned.

    10
    UserSensitiveDataSwitchList

    array<object>

    The list of sensitive data detection switches.

    object

    The list of sensitive data detection switches.

    CategoryName

    string

    The name of the sensitive credential category.

    身份证
    Description

    string

    The description of the sensitive credential.

    身份证敏感数据泄漏
    SensitiveCategory

    string

    The type of the sensitive credential.

    id_card
    SensitiveLevel

    string

    The sensitivity level.

    S3
    SwitchStatus

    integer

    The status of the sensitive data detection switch.

    Valid values:

    • 0 :

      disabled

    • 1 :

      enabled

    1
    OpenCount

    integer

    The total number of enabled items.

    80

    Examples

    Success response

    JSON format

    {
  "RequestId": "A7F3ED45-5556-5AF3-ADE3-EE48FFF0****",
  "TotalCount": 10,
  "UserSensitiveDataSwitchList": [
    {
      "CategoryName": "身份证",
      "Description": "身份证敏感数据泄漏",
      "SensitiveCategory": "id_card",
      "SensitiveLevel": "S3",
      "SwitchStatus": 1
    }
  ],
  "OpenCount": 80
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.