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

Consulta la información de una plantilla de permisos.

Descripción de la operación

Debe ser administrador de Data Management (DMS) o administrador de bases de datos (DBA). Para obtener más información sobre cómo ver los roles del sistema, consulte Ver roles del sistema.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
TemplateId	integer	Sí	El ID de la plantilla de permisos.	1563
Tid	integer	No	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant o ListUserTenants para consultar el ID del inquilino.	3***

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	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
AuthorityTemplateView	object	Los detalles de la plantilla de permisos.
TemplateId	integer	El ID de la plantilla de permisos.	1563
CreatorId	integer	El ID del usuario que creó la plantilla de permisos.	12***
Name	string	El nombre de la plantilla de permisos.	测试模板
Description	string	La descripción de la plantilla de permisos.	此模板用于业务测试
CreateTime	string	La hora en que se creó la plantilla de permisos. La hora tiene el formato yyyy-MM-DD HH:mm:ss.	2023-01-01 00:00:00
AuthorityTemplateItemList	object
AuthorityTemplateItem	array<object>	La información de recursos en la plantilla de permisos.
	object
ItemId	integer	El ID del recurso.	12***
TemplateId	integer	El ID de la plantilla de permisos.	1563
ModifierId	integer	El ID del usuario que modificó el recurso.	51***
ResourceType	string	El tipo de recurso. Valores válidos: INSTANCE: instancia LOGIC_DB: base de datos lógica META_DB: base de datos física LOGIC_TABLE: tabla lógica SINGLE_TABLE: tabla física	INSTANCE
InstanceId	integer	El ID de la instancia.	188****
DbId	integer	El ID de la base de datos.	43***
TableName	string	El nombre de la tabla.	ExampleTable
Attribute	string	Otra información. Por ejemplo, puede agregar el permiso de inicio de sesión en una instancia a la plantilla de permisos.	"permissionTypes": [ "LOGIN" ]
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
Tid	integer	El ID del inquilino.	3***

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "AuthorityTemplateView": {
    "TemplateId": 1563,
    "CreatorId": 0,
    "Name": "Test template.",
    "Description": "This template is used for business testing.",
    "CreateTime": "2023-01-01 00:00:00",
    "AuthorityTemplateItemList": {
      "AuthorityTemplateItem": [
        {
          "ItemId": 0,
          "TemplateId": 1563,
          "ModifierId": 0,
          "ResourceType": "INSTANCE",
          "InstanceId": 0,
          "DbId": 0,
          "TableName": "ExampleTable",
          "Attribute": "\"permissionTypes\": [\n            \"LOGIN\"\n          ]"
        }
      ]
    }
  },
  "Success": true,
  "Tid": 0
}

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.