All Products
Search

This Product

    Data Management:GetTableDesignProjectInfo

    Document Center

    Data Management:GetTableDesignProjectInfo

    Last Updated:Nov 28, 2024

    Queries the information about the project and change base database of a schema design ticket, such as the state of the ticket, the ID of the user who created the ticket, and the name and ID of the change base database.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    dms:GetTableDesignProjectInfoget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    OrderIdlongYes

    The ID of the schema design ticket. You can call the ListOrders operation to obtain the ID.

    		95****
    TidlongNo

    The tenant ID.

    Note To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant section of the "Manage DMS tenants" topic
    		3***

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID. You can use the request ID to query logs and troubleshoot issues.

    		48778434-5796-571A-8455-A59146588401
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    ErrorMessagestring

    The error message returned if the request failed.

    		UnknownError
    ErrorCodestring

    The error code returned if the request failed.

    		UnknownError
    ProjectInfoobject

    The information about the schema design project.

    OrderIdlong

    The ticket ID.

    		95****
    ProjectIdlong

    The project ID.

    		12****
    GmtCreatestring

    The time when the ticket was created.

    		2024-04-23 02:57:01
    GmtModifiedstring

    The time when the ticket was last modified.

    		2024-04-23 02:57:01
    Statusstring

    The state of the schema design project. Valid values:

    • DESIGN: The schema is being designed.
    • PUBLISHED: The schema is published.
    • CLOSE: The ticket is closed.
    		DESIGN
    Titlestring

    The name of the schema design project.

    		test
    Descriptionstring

    The description of the schema design project.

    		test
    CreatorIdlong

    The ID of the user who created the ticket.

    		71****
    BaseDatabaseobject

    The information about the change base database of the schema design ticket.

    SearchNamestring

    The name that is used to search for the database.

    		schema_name@127.0.XX.XX
    SchemaNamestring

    The database name.

    		bk_atc020
    DbIdinteger

    The database ID.

    		11****
    Logicboolean

    Indicates whether the database is a logical database. Valid values:

    • true
    • false
    		false
    Aliasstring

    The alias of the database instance.

    		poc_test
    EnvTypestring

    The type of the environment in which the database instance is deployed. Valid values:

    • product: production environment.
    • dev: development environment.
    • pre: pre-release environment.
    • test: test environment.
    • sit: system integration testing (SIT) environment.
    • uat: user acceptance testing (UAT) environment.
    • pet: stress testing environment.
    • stag: staging environment.
    		dev
    DbTypestring

    The type of the database. For more information about the valid values of this parameter, see DbType parameter.

    		POLARDB

    Examples

    Sample success responses

    JSONformat

    {
  "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": "test",
    "Description": "test",
    "CreatorId": 0,
    "BaseDatabase": {
      "SearchName": "schema_name@127.0.XX.XX",
      "SchemaName": "bk_atc020",
      "DbId": 0,
      "Logic": false,
      "Alias": "poc_test",
      "EnvType": "dev",
      "DbType": "POLARDB"
    }
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.