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

Consulta la información sobre el proyecto y la base de datos de referencia de cambios de un ticket de diseño de esquema, como el estado del ticket, el ID del usuario que creó el ticket, y el nombre y el ID de la base de datos de referencia de cambios.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
OrderId	integer	Sí	El ID del ticket de diseño de esquema. Puede llamar a la operación ListOrders para obtener el ID.	95****
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, vaya a la consola de Data Management (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	Los parámetros de la respuesta.
RequestId	string	El ID de la solicitud. Puede utilizar el ID de la solicitud para consultar registros y solucionar problemas.	48778434-5796-571A-8455-A59146588401
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true false	true
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ProjectInfo	object	La información sobre el proyecto de diseño de esquema.
OrderId	integer	El ID del ticket.	95****
ProjectId	integer	El ID del proyecto.	12****
GmtCreate	string	La hora en que se creó el ticket.	2024-04-23 02:57:01
GmtModified	string	La hora en que se modificó por última vez el ticket.	2024-04-23 02:57:01
Status	string	El estado del proyecto de diseño de esquema. Valores válidos: DESIGN: El esquema está en fase de diseño. PUBLISHED: El esquema está publicado. CLOSE: El ticket está cerrado.	DESIGN
Title	string	El nombre del proyecto de diseño de esquema.	用户增长战役
Description	string	La descripción del proyecto de diseño de esquema.	测试
CreatorId	integer	El ID del usuario que creó el ticket.	71****
BaseDatabase	object	La información sobre la base de datos de referencia de cambios del ticket de diseño de esquema.
SearchName	string	El nombre que se utiliza para buscar la base de datos.	schema_name@127.0.XX.XX
SchemaName	string	El nombre de la base de datos.	bk_atc020
DbId	integer	El ID de la base de datos.	11****
Logic	boolean	Indica si la base de datos es una base de datos lógica. Valores válidos: true false	false
Alias	string	El alias de la instancia de base de datos.	核心交易库
EnvType	string	El tipo de entorno en el que se despliega la instancia de base de datos. Valores válidos: product: entorno de producción. dev: entorno de desarrollo. pre: entorno de prelanzamiento. test: entorno de pruebas. sit: entorno de prueba de integración del sistema (SIT). uat: entorno de prueba de aceptación del usuario (UAT). pet: entorno de prueba de estrés. stag: entorno de preparación.	dev
DbType	string	El tipo de la base de datos. Para obtener más información sobre los valores válidos de este parámetro, consulte Parámetro DbType.	POLARDB

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "48778434-5796-571A-8455-A59146588401",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "ProjectInfo": {
    "OrderId": 0,
    "ProjectId": 0,
    "GmtCreate": "2024-04-23 02:57:01",
    "GmtModified": "2024-04-23 02:57:01",
    "Status": "DESIGN",
    "Title": "User growth campaign",
    "Description": "Test",
    "CreatorId": 0,
    "BaseDatabase": {
      "SearchName": "schema_name@127.0.XX.XX",
      "SchemaName": "bk_atc020",
      "DbId": 0,
      "Logic": false,
      "Alias": "Core transaction database",
      "EnvType": "dev",
      "DbType": "POLARDB"
    }
  }
}

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.