ListSensitiveColumnInfo - Data Management - Centro de documentación de Alibaba Cloud

Consulta la información de un campo sensible. La información incluye el ID del algoritmo de enmascaramiento, el nombre del algoritmo de enmascaramiento y el nivel de seguridad del campo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dms:ListSensitiveColumnInfo

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	integer	Sí	El ID de la instancia. Puede llamar a la operación ListInstances o GetInstance para consultar el ID de la instancia.	183****
SchemaName	string	No	El nombre de la base de datos. También puede llamar a la operación SearchDatabase para consultar el nombre de la base de datos. Nota También puede llamar a la operación ListDatabases para consultar el valor del parámetro SchemaName de una base de datos física, o a la operación ListLogicDatabases para consultar el valor del parámetro SchemaName de una base de datos lógica.	test_schema
TableName	string	No	El nombre de la tabla. Puede llamar a la operación ListSensitiveColumns para consultar el nombre de la tabla. Nota También puede llamar a la operación ListTables para consultar el nombre de la tabla.	test_table
ColumnName	string	No	El nombre del campo sensible. Puede llamar a la operación ListSensitiveColumns para consultar el nombre del campo sensible. Nota También puede llamar a la operación ListColumns para consultar el nombre del campo sensible.	test_column
PageNumber	integer	No	El número de página de la página devuelta.	1
PageSize	integer	No	El número de entradas que se devolverán en cada página.	100
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, vaya a la consola de DMS y pase el puntero sobre la foto de perfil en la esquina superior derecha. Para obtener más información, consulte la sección Ver información sobre el inquilino actual del tema "Gestionar inquilinos de DMS".	3***

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Puede utilizar el ID de la solicitud para localizar registros y solucionar problemas.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
SensitiveColumnList	object
SensitiveColumn	array<object>	Los detalles del campo sensible.
	array<object>	Los detalles del campo.
InstanceId	integer	El ID de la instancia.	183****
SchemaName	string	El nombre de la base de datos.	test_schema
TableName	string	El nombre de la tabla.	test_table
ColumnName	string	El nombre del campo sensible.	test_column
CategoryName	string	El nombre de la categoría.	默认分类
IsPlain	boolean	Indica si el campo sensible se muestra en texto sin formato.	False
SecurityLevel	string	El nivel de sensibilidad del campo. Valores válidos: Low Medium High	低
UserSensitivityLevel	string	El nivel de sensibilidad definido por el usuario.	S1
SampleData	string	Los datos de muestra.	西安市
DefaultDesensitizationRule	object	La información sobre el algoritmo de enmascaramiento predeterminado.
RuleId	integer	El ID del algoritmo de enmascaramiento.	101**
RuleName	string	El nombre del algoritmo de enmascaramiento.	test
SemiDesensitizationRuleList	object
SemiDesensitizationRule	array<object>	La lista de algoritmos de enmascaramiento parcial.
	object	Los detalles del algoritmo de enmascaramiento parcial.
RuleId	integer	El ID del algoritmo de enmascaramiento parcial.	10***
RuleName	string	El nombre del algoritmo de enmascaramiento parcial.	test01
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
TotalCount	integer	El número total de entradas devueltas.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "SensitiveColumnList": {
    "SensitiveColumn": [
      {
        "InstanceId": 0,
        "SchemaName": "test_schema",
        "TableName": "test_table",
        "ColumnName": "test_column",
        "CategoryName": "默认分类",
        "IsPlain": true,
        "SecurityLevel": "低",
        "UserSensitivityLevel": "S1",
        "SampleData": "西安市",
        "DefaultDesensitizationRule": {
          "RuleId": 0,
          "RuleName": "test"
        },
        "SemiDesensitizationRuleList": {
          "SemiDesensitizationRule": [
            {
              "RuleId": 0,
              "RuleName": "test01"
            }
          ]
        }
      }
    ]
  },
  "Success": true,
  "TotalCount": 1
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.