Queries the information of a specific database.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Name String Yes db001

The name of the database whose information you want to query.

Response parameters

Parameter Type Example Description
Code String NO_SUCH_OBJECT

The error code returned.

DatabaseModel object

The model of the database.

Description String this is db description

The description of the database.

LocationUri String oss://data/xxx

The URL of the Object Storage Service (OSS) bucket in which data in the database is stored.

Name String db001

The name of the database.

OwnerName String user001

The username of the sub-account used by the creator of the database.

Parameters Map

The attributes of the database.

String key001=value001

The values of database attributes.

TenantId String 123455

The ID of the Alibaba Cloud account used to access DLA.

Message String The database db001 does not exist

The error message returned.

RequestId String 9BEAC206-0795-4DE3-B1FD-964BEF432B23

The ID of the request.

Success Boolean false

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Name=db001
&<Common request parameters>

Sample success responses

XML format

<DatabaseModel>
    <LocationUri>oss://data/xxx</LocationUri>
    <OwnerName>user001</OwnerName>
    <TenantId>123455</TenantId>
    <Description>this is db description</Description>
    <Parameters>
        <key>key001=value001</key>
    </Parameters>
    <Name>db001</Name>
</DatabaseModel>
<Message>The database db001 does not exist</Message>
<RequestId>9BEAC206-0795-4DE3-B1FD-964BEF432B23</RequestId>
<Code>NO_SUCH_OBJECT</Code>
<Success>false</Success>

JSON format

{
    "DatabaseModel": {
        "LocationUri": "oss://data/xxx",
        "OwnerName": "user001",
        "TenantId": "123455",
        "Description": "this is db description",
        "Parameters": {
            "key": "key001=value001"
        },
        "Name": "db001"
    },
    "Message": "The database db001 does not exist",
    "RequestId": "9BEAC206-0795-4DE3-B1FD-964BEF432B23",
    "Code": "NO_SUCH_OBJECT",
    "Success": "false"
}

Error codes

For a list of error codes, visit the API Error Center.