DescribeLogHubAttribute API とログ配送ジョブ属性 - AnalyticDB for MySQL

ログ配布ジョブの情報を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeLogHubAttribute

get

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
DBClusterId	string	必須	AnalyticDB for MySQL Data Warehouse Edition クラスターの ID。	am-bp1nz6smy07szs58p
ProjectName	string	必須	Simple Log Service プロジェクトの名前。	dcsz-af-data
DeliverName	string	必須	ログ配布ジョブの名前。	sz_sls2adb_kxdpz_af_data
LogStoreName	string	必須	Logstore の名前。	game2-sms-log

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	8A564B7F-8C00-43C0-8EC5-919FBB70573
LoghubInfo	object	ログ収集情報。
Delay	integer	同期遅延。同期ジョブの最終更新時刻と現在のシステム時刻との間の遅延です。単位：秒。	361
TableName	string	テーブルの名前。	test2
LogHubStores	object
LogHubStore	array<object>	Logstore の名前。
	object	Logstore の名前。
LogKey	string	ログキーワード。	taskid
FieldKey	string	ログキーワードの値。	255311
ProjectName	string	Simple Log Service プロジェクトの名前。	test-adb
DBType	string	データベースのタイプ。	rds
SchemaName	string	データベースの名前。	cbd_bi
SyncStatus	string	同期ステータス。	processing
Message	string	返されるメッセージ。	SUCCESS
DeliverName	string	ログ配布ジョブの名前。	loghub-web-login-new
RegionId	string	リージョン ID。	cn-hangzhou
DBClusterId	string	クラスター ID。	am-8vbs48m7553du1gz2
Description	string	説明。	description
FilterDirtyData	boolean	ダーティデータをフィルターするかどうかを示します。	true
LogStoreName	string	Logstore の名前。	device_login
ZoneId	string	ゾーン ID。	cn-hangzhou-k
UserName	string	データベースアカウントの名前。	aaa
DeliverTime	string	ログ配布時間。	2024-12-06'T'10:15'Z'

例

成功レスポンス

JSONJSON

{
  "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'"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。