DescribeLoghubDetail API Reference for Log Collection - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Queries the details of log collection.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeLoghubDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The resource group ID.	rg-4690g37929****
RegionId	string	Yes	The region ID.	cn-hangzhou
ProjectName	string	Yes	The name of the log project.	sls-hz-php-ad
ExportName	string	Yes	The name of the Simple Log Service delivery task.	wap_log_full_to_adb

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
LoghubInfo	object	The log collection information.
TableName	string	The table name.	test2
LogHubStores	object
LogHubStore	array<object>	The log keyword.
	object	The log keyword.
LogKey	string	The log keyword.	put_request
FieldKey	string	The value corresponding to the keyword.	channel_id
ProjectName	string	The name of the log project.	test-adb
SchemaName	string	The database name.	cbd_bi
DBType	string	The instance type.	rds
DeliverName	string	The delivery name.	hub-pay-callback-ykt
RegionId	string	The region ID.	cn-shenzhen
DBClusterId	string	The cluster ID.	am-8vbs48m7553du1gz2
Description	string	The description.	aaa
FilterDirtyData	boolean	Indicates whether dirty data is filtered.	true
ZoneId	string	The zone ID.	cn-hangzhou-k
LogStoreName	string	The name of the Simple Log Service Logstore.	device_login
UserName	string	The username.	test
DeliverTime	string	The delivery time.	2024-12-06'T'10:15'Z'
DomainUrl	string	The domain name.	am-bp1p38m2c26s7hpk690650.ads.aliyuncs.com

Examples

Success response

JSON format

{
  "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 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.