DescribeLogHubAttribute API & Log Shipping Job Attributes - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Queries the details of an SLA system link.

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:DescribeLogHubAttribute

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8A564B7F-8C00-43C0-8EC5-919FBB70573
LoghubInfo	object	The log collection information.
Delay	integer	The synchronization delay, which is the difference between the latest update time of the synchronization task and the current system time. Unit: seconds.	361
TableName	string	The name of the data table.	test2
LogHubStores	object
LogHubStore	array<object>	The name of the Logstore.
	object	The Logstore object.
LogKey	string	The log keyword.	taskid
FieldKey	string	The value that corresponds to the keyword.	255311
ProjectName	string	The name of the log project.	test-adb
DBType	string	The instance type.	rds
SchemaName	string	The database name.	cbd_bi
SyncStatus	string	The synchronization status.	processing
Message	string	The additional information about the call result.	SUCCESS
DeliverName	string	The delivery name.	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 Simple Log Service Logstore.	device_login
ZoneId	string	The zone ID.	cn-hangzhou-k
UserName	string	The username.	aaa
DeliverTime	string	The delivery time.	2024-12-06'T'10:15'Z'

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.