DescribeLogHubAttribute - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about a log shipping job.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeLogHubAttribute	get	DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.	am-bp1nz6smy07szs58p
ProjectName	string	Yes	The name of the Simple Log Service project.	dcsz-af-data
DeliverName	string	Yes	The name of the log shipping job.	sz_sls2adb_kxdpz_af_data
LogStoreName	string	Yes	The name of the Logstore.	game2-sms-log

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	8A564B7F-8C00-43C0-8EC5-919FBB70573
LoghubInfo	object	The log collection information.
Delay	long	The synchronization latency, which is the latency between the latest update time of the synchronization job and the current system time. Unit: seconds.	361
TableName	string	The name of the table.	test2
LogHubStores	array<object>	The names of the Logstores.
LogHubStore	object	The name of the Logstore.
LogKey	string	The log keyword.	taskid
FieldKey	string	The value of the log keyword.	255311
ProjectName	string	The name of the Simple Log Service project.	test-adb
DBType	string	The database type.	rds
SchemaName	string	The name of the database.	cbd_bi
SyncStatus	string	The synchronization status.	processing
Message	string	The returned message.	SUCCESS
DeliverName	string	The name of the log shipping job.	loghub-web-login-new
RegionId	string	The region ID.	cn-hangzhou
DBClusterId	string	The cluster ID.	am-8vbs48m7553du1gz2
Description	string	The description.	description
FilterDirtyData	boolean	Indicates whether dirty data is filtered.	true
LogStoreName	string	The name of the Logstore.	device_login
ZoneId	string	The zone ID.	cn-hangzhou-k
UserName	string	The name of the database account.	aaa
DeliverTime	string	The log shipping time.	2024-12-06'T'10:15'Z'

Examples

Sample success responses

JSONformat

{
  "RequestId": "8A564B7F-8C00-43C0-8EC5-919FBB70573",
  "LoghubInfo": {
    "Delay": 361,
    "TableName": "test2",
    "LogHubStores": {
      "LogHubStore": [
        {
          "LogKey": "taskid",
          "FieldKey": 255311
        }
      ]
    },
    "ProjectName": "test-adb",
    "DBType": "rds",
    "SchemaName": "cbd_bi",
    "SyncStatus": "processing",
    "Message": "SUCCESS",
    "DeliverName": "loghub-web-login-new",
    "RegionId": "cn-hangzhou",
    "DBClusterId": "am-8vbs48m7553du1gz2",
    "Description": "description",
    "FilterDirtyData": true,
    "LogStoreName": "device_login",
    "ZoneId": "cn-hangzhou-k",
    "UserName": "aaa",
    "DeliverTime": "2024-12-06'T'10:15'Z'"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The 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 time	Summary of changes	Operation

No change history