All Products
Search
Document Center

AnalyticDB:DescribeLoghubDetail

Last Updated:Jan 08, 2026

Queries the log collection information.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
adb:DescribeLoghubDetailget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The resource group ID.

rg-4690g37929****
RegionIdstringYes

The region ID.

cn-hangzhou
ProjectNamestringYes

The name of the Simple Log Service project.

sls-hz-php-ad
ExportNamestringYes

The name of the log shipping job.

wap_log_full_to_adb

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
LoghubInfoobject

The queried log collection information.

TableNamestring

The name of the table.

test2
LogHubStoresarray<object>

The log keywords.

LogHubStoreobject

The log keyword.

LogKeystring

The log keyword.

put_request
FieldKeystring

The value of the log keyword.

channel_id
ProjectNamestring

The name of the Simple Log Service project.

test-adb
SchemaNamestring

The name of the database.

cbd_bi
DBTypestring

The database type.

rds
DeliverNamestring

The name of the log shipping job.

hub-pay-callback-ykt
RegionIdstring

The region ID.

cn-shenzhen
DBClusterIdstring

The cluster ID.

am-8vbs48m7553du1gz2
Descriptionstring

The description.

aaa
FilterDirtyDataboolean

Indicates whether dirty data is filtered.

true
ZoneIdstring

The zone ID.

cn-hangzhou-k
LogStoreNamestring

The name of the Logstore.

device_login
UserNamestring

The name of the database account.

test
DeliverTimestring

The log shipping time.

2024-12-06'T'10:15'Z'
DomainUrlstring

The endpoint.

am-bp1p38m2c26s7hpk690650.ads.aliyuncs.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "LoghubInfo": {
    "TableName": "test2",
    "LogHubStores": {
      "LogHubStore": [
        {
          "LogKey": "put_request",
          "FieldKey": "channel_id"
        }
      ]
    },
    "ProjectName": "test-adb",
    "SchemaName": "cbd_bi",
    "DBType": "rds",
    "DeliverName": "hub-pay-callback-ykt",
    "RegionId": "cn-shenzhen",
    "DBClusterId": "am-8vbs48m7553du1gz2",
    "Description": "aaa",
    "FilterDirtyData": true,
    "ZoneId": "cn-hangzhou-k",
    "LogStoreName": "device_login",
    "UserName": "test",
    "DeliverTime": "2024-12-06'T'10:15'Z'",
    "DomainUrl": "am-bp1p38m2c26s7hpk690650.ads.aliyuncs.com"
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Change history

Change timeSummary of changesOperation
No change history