Gunakan GetDataArchiveOrderDetail untuk mengkueri detail tiket pengarsipan data - Manajemen Data - Alibaba Cloud - Data Management

Panggil API ini untuk memperoleh detail tiket pengarsipan data, termasuk waktu pembuatan tiket, informasi penjadwalan tugas, log tugas pengarsipan, dan informasi basis data pengarsipan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetDataArchiveOrderDetail

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	ID tiket pengarsipan data.	868****
Tid	integer	No	ID penyewa. Catatan ID ditampilkan saat Anda memindahkan penunjuk ke gambar profil di pojok kanan atas konsol DMS. Untuk informasi lebih lanjut, lihat Lihat informasi tentang penyewa saat ini.	5***

Elemen respons

Element	Type	Description	Example
	object
TraceId	string	ID jejak yang digunakan untuk melacak permintaan layanan.	0a06e1e316757357507896067d3780
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
ErrorMessage	string	Pesan kesalahan yang dikembalikan.	User [199295823****] not exist
ErrorCode	string	Kode kesalahan yang dikembalikan.	NoPermission
RequestId	string	ID permintaan, yang digunakan untuk menemukan log dan memecahkan masalah.	4161CE36-28DF-5191-8A6F-A17076A0B124
DataArchiveOrderDetail	object	Detail tiket pengarsipan data.
Comment	string	Keterangan tiket pengarsipan data.	Archiving of test results
Committer	string	Pengguna yang mengirimkan tiket.	dmstest
CommitterId	integer	ID pengguna pengirim tiket. Ini bukan UID Alibaba Cloud.	26***
GmtCreate	string	Waktu saat tiket dibuat.	2023-05-15 16:00:48
GmtModified	string	Waktu terakhir kali tiket dimodifikasi.	2023-05-23 16:00:48
Id	integer	ID tiket pengarsipan data.	868****
PluginExtraData	object	Informasi tambahan dari tiket.
DagInfo	object	The information about the workflow.
CreatorId	string	The ID of the user who created the task flow.	59****
CronBeginDate	string	The start time for scheduling. The task flow is not scheduled before this point in time.	1970-01-01
CronEndDate	string	The end time for scheduling. The task flow is not scheduled after this point in time.	9999-01-01
CronTrigger	boolean	Indicates whether the archiving task is a scheduled task. Valid values: true false	false
DWDevelop	boolean	Indicates whether the task is used to develop warehouses. Catatan This field is a retained field that is not in use.	false
DagName	string	The name of the workflow.	data-archive-9099197
DagOwnerId	string	The ID of the owner of the workflow.	13****
DeployId	integer	The ID of the deployment record.	93***
Description	string	The description of the workflow.	order id:9099197
EditDagId	integer	The ID of the editable workflow version.	24***
GmtCreate	string	The time when the workflow was created.	2023-05-15 16:00:48
GmtModified	string	The time when the workflow was last modified.	2023-06-15 16:00:48
Id	integer	The ID of the task flow.	24***
IsPublic	integer	Indicates whether the workflow is public. Valid values: 0: not public. 1: public.	0
Legacy	boolean	Indicates whether the task is a historical task. Valid values: true false	false
System	boolean	Indicates whether the task was created by the system. Valid values: true false	false
TenantId	string	The tenant ID.	5***
TriggerOnce	boolean	Indicates whether the workflow is triggered to run once. Valid values: true false	false
DbBaseInfo	object	The database information related to data archiving tickets.
Alias	string	The alias of the database instance.	tf-testAccDMSEnterpriseLogicDatabase853****
AlterTimeout	integer	The timeout period of queries on the database.	600
AssetControl	boolean	Indicates whether access control is enabled for data assets. Valid values: true false	true
CatalogName	string	The name of the instance in the instance list.	test
ClusterNode	string	Indicates whether the instance is added to the DMS whitelist.	whitelist_done
DbId	integer	The ID of the database. You can call the SearchDatabase operation to query the ID of the database. Catatan You can call the ListDatabases operation to query the ID of a physical database or the ListLogicDatabases operation to query the ID of a logical database.	348****
DbType	string	The type of the database. For information about the valid values of this parameter, see DbType parameter.	MySQL
DbaId	integer	The ID of the database administrator (DBA) of the instance.	16****
DbaName	string	The nickname of the DBA of the instance.	DBA
Description	string	The complete endpoint of the database.	test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]
Encoding	string	The encoding format of the database.	utf8
EnvType	string	The type of the environment to which the database belongs. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: system integration testing (SIT) environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment	product
Follow	boolean	Indicates whether the instance needs special attention. Valid values: true false	false
Host	string	The endpoint that is used to connect to the database.	rm-2ze756u8837****.mysql.rds.aliyuncs.com
Idc	string	The region in which the database instance resides.	cn-beijing
IdcTitle	string	The name of the region in which the database instance resides.	cn-beijing
InstanceId	integer	The ID of the instance to which the database belongs.	175****
InstanceSource	string	The source of the database instance.Valid values: RDS: an ApsaraDB RDS instance. ECS_OWN: a self-managed database deployed on an Elastic Compute Service (ECS) instance. PUBLIC_OWN: a self-managed database instance that is connected over the Internet. VPC_ID: a self-managed database instance in a virtual private cloud (VPC) that is connected over Express Connect circuits. GATEWAY: a database instance connected by using a database gateway.	RDS
LastSyncTime	string	The time when the database information was last obtained.	2023-05-14 18:34:45
Level	string	The instance level.	中
Logic	boolean	Indicates whether the database is logical. Valid values: true false	false
OwnerIds	array	The IDs of the owners of the databases, which are stored as an array. You can call the GetUser or ListUsers operation to query the IDs of the owners. Catatan The value of OwnerIds is the same as the value of UserId
	integer	The ID of the owner of the instance.	77****
OwnerNames	array	The usernames of the database owners.
	string	The username of the database owner.	天天
Port	integer	The port that is used to connect to the database.	3306
SchemaName	string	The name of the database.	test
SearchName	string	The name that is used to search for the database.	test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]
StandardGroup	object	The details of the control mode of the instance.
DbType	string	The type of the instance engine. For information about the valid values of this parameter, see DbType parameter.	MySQL
Description	string	The description of the security rule set.	adb_mysql default
FreeOrStable	boolean	Indicates whether the instance is managed in Flexible Management or Stable Change mode. Valid values: true false	false
GmtCreate	string	The time when the security rule was created.	2020-05-24 14:12:32
GmtModified	string	The time when the security rule was last modified.	2020-05-25 14:12:32
GroupMode	string	The type of the control mode of the instance. Valid values: COMMON: The instance is managed in Security Collaboration mode. NONE_CONTROL: The instance is managed in Flexible Management mode. STABLE: The instance is managed in Stable Change mode.	COMMON
GroupName	string	The name of the security rule that corresponds to the control mode.	adb_mysql default
Id	integer	The ID of the security rule.	24***
LastMenderId	integer	The user ID of the last modified security rule.	12****
State	string	The status of the database. Valid values: NORMAL: The database is running as expected. DISABLE: The database is disabled. OFFLINE: The database is unpublished. NOT_EXIST: The database does not exist.	NORMAL
TableCount	integer	The number of tables.	201
TnsName	string	The name of TNS.	TNS_4010
UnitType	string	The unit type.	-1
InstanceTotal	integer	The total number of archiving tasks.	2
Instances	array<object>	The list of archiving tasks.
	object
BusinessTime	string	The business time of the task flow. The time is displayed in the yyyy-MM-DD HH:mm:ss format.	2023-05-14 16:00:57
DagId	integer	The task flow ID. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to obtain the value of this parameter.	37***
EndTime	string	The time when the task flow ended. The time is displayed in the yyyy-MM-DD HH:mm:ss format.	2022-06-04 15:14:00
GmtCreate	string	The time when the task flow was created.	2023-05-14 16:00:57
GmtModified	string	The time when the task flow was last modified.	2023-05-14 16:00:57
HistoryDagId	integer	The ID of the historical task flow.	32***
Id	integer	The ID of the instance in the task flow that is executed.	24***
LastRunningContext	string	The context of the previous execution of the task flow.	{ "nodes": [ 48** ], "edges": {} }
Msg	string	The context of the current execution of the task flow.	归档任务日志：2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023
Status	integer	The status of the task. Valid values: 0: The task is waiting for execution. 1: The task is in progress. 2: The task is suspended. 3: The task failed. 4: The task is successful. 5: The task is complete.	4
TenantId	string	The tenant ID.	5***
TriggerType	integer	The mode in which the task flow was triggered. Valid values: 0: The task flow was triggered based on a schedule. 1: The task flow was manually triggered.	1
Version	string	The version number.	1
NextFireTimeResult	object	The time when the next task is triggered.
CronFireType	string	The type of scheduled triggering.	NOT_SET
PageIndex	integer	The page number.	10
PageSize	integer	The number of entries per page.	20
TempTableNameMap	object	The name of the temporary table that is generated by the archiving task (indicated by the archiving task ID).	{ "803***": [ "tmp_dms_21321_20230704144336_temp_test_check" ] }
PluginParam	object	Parameter yang digunakan untuk membuat tiket. Nilainya adalah string JSON. Untuk informasi lebih lanjut, lihat Deskripsi parameter PluginType.
ArchiveMethod	string	The type of the archiving destination.	inner_oss
DbSchema	string	The schema of the database and table to be archived.	test
Logic	boolean	Indicates whether the database is logical. true false	true
OrderAfter	array	The post behavior of archiving.
	string	The post behavior of archiving. The post behavior is to use the DELETE statement to clean up the table.	delete
RunMethod	string	The running method, which indicates whether to run the task immediately or at a specific point in time.	now
SourceDatabaseId	integer	The ID of the source database.	12***
TableIncludes	array<object>	The list of the archived tables and the filter conditions.
	object
TableName	string	The table name.	tm_insured_cb
TableWhere	string	The filter condition.	id<1000或者gmt_create<'2023-05-14 16:00:57'
TableMapping	array	The mapping of schemas.
	string	The mapping of the source table name, source column name, destination table name, and destination column name.	{ "schema": "oracle_info", "tarTb": "eoa_context_test", "tbPartKey": [], "oriTb": "eoa_context", "columns": [ { "tName": "dbid_test", "oName": "dbid" } ], "dbPartKey": [], "customPk": [ "id" ] }
TargetInstanceId	string	The ID of the destination instance.	12***
Variables	array	The time variable defined for scheduled archiving.
	string	The time variable that calculates an offset based on the previous day of the current time.	{ "name": "test", "pattern": "yyyy-MM-dd\|-10d" }
PluginType	string	PluginType yang sesuai dengan jenis tiket. PluginType untuk pengarsipan data adalah DATA_ARCHIVE. Untuk informasi lebih lanjut, lihat Deskripsi parameter PluginType.	DATA_ARCHIVE
RelatedUserList	array	ID pengguna yang terkait dengan tiket.
	integer	ID pengguna yang terkait dengan tiket.	65****
RelatedUserNickList	array	Daftar nama panggilan pengguna yang terkait dengan tiket.
	string	Nama panggilan pengguna yang terkait dengan tiket.	publicyuhzou
StatusCode	string	Kode status tiket. Nilai yang valid: new: baru dibuat. toaudit: menunggu persetujuan. approved: disetujui. reject: ditolak. processing: sedang berlangsung. success: berhasil. closed: ditutup.	processing
StatusDesc	string	Deskripsi status tiket.	正在执行工单任务。
WorkflowInstanceId	integer	ID alur kerja persetujuan. Anda dapat memanggil operasi GetOrderBaseInfo untuk memperoleh nilai parameter ini.	29****
WorkflowStatusDesc	string	Deskripsi persetujuan.	审批通过

Contoh

Respons sukses

JSONformat

{
  "TraceId": "0a06e1e316757357507896067d3780",
  "Success": true,
  "ErrorMessage": "User [199295823****] not exist",
  "ErrorCode": "NoPermission",
  "RequestId": "4161CE36-28DF-5191-8A6F-A17076A0B124",
  "DataArchiveOrderDetail": {
    "Comment": "Archiving of test results",
    "Committer": "dmstest",
    "CommitterId": 0,
    "GmtCreate": "2023-05-15 16:00:48",
    "GmtModified": "2023-05-23 16:00:48",
    "Id": 0,
    "PluginExtraData": {
      "DagInfo": {
        "CreatorId": "59****",
        "CronBeginDate": "1970-01-01",
        "CronEndDate": "9999-01-01",
        "CronTrigger": false,
        "DWDevelop": false,
        "DagName": "data-archive-9099197",
        "DagOwnerId": "13****",
        "DeployId": 0,
        "Description": "order id:9099197",
        "EditDagId": 0,
        "GmtCreate": "2023-05-15 16:00:48",
        "GmtModified": "2023-06-15 16:00:48",
        "Id": 0,
        "IsPublic": 0,
        "Legacy": false,
        "System": false,
        "TenantId": "5***",
        "TriggerOnce": false
      },
      "DbBaseInfo": {
        "Alias": "tf-testAccDMSEnterpriseLogicDatabase853****",
        "AlterTimeout": 600,
        "AssetControl": true,
        "CatalogName": "test",
        "ClusterNode": "whitelist_done",
        "DbId": 0,
        "DbType": "MySQL",
        "DbaId": 0,
        "DbaName": "DBA",
        "Description": "test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]",
        "Encoding": "utf8",
        "EnvType": "product",
        "Follow": false,
        "Host": "rm-2ze756u8837****.mysql.rds.aliyuncs.com",
        "Idc": "cn-beijing",
        "IdcTitle": "cn-beijing",
        "InstanceId": 0,
        "InstanceSource": "RDS",
        "LastSyncTime": "2023-05-14 18:34:45",
        "Level": "中",
        "Logic": false,
        "OwnerIds": [
          0
        ],
        "OwnerNames": [
          "天天"
        ],
        "Port": 3306,
        "SchemaName": "test",
        "SearchName": "test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]",
        "StandardGroup": {
          "DbType": "MySQL",
          "Description": "adb_mysql default",
          "FreeOrStable": false,
          "GmtCreate": "2020-05-24 14:12:32",
          "GmtModified": "2020-05-25 14:12:32",
          "GroupMode": "COMMON",
          "GroupName": "adb_mysql default",
          "Id": 0,
          "LastMenderId": 0
        },
        "State": "NORMAL",
        "TableCount": 201,
        "TnsName": "TNS_4010",
        "UnitType": "-1"
      },
      "InstanceTotal": 2,
      "Instances": [
        {
          "BusinessTime": "2023-05-14 16:00:57",
          "DagId": 0,
          "EndTime": "2022-06-04 15:14:00",
          "GmtCreate": "2023-05-14 16:00:57",
          "GmtModified": "2023-05-14 16:00:57",
          "HistoryDagId": 0,
          "Id": 0,
          "LastRunningContext": "{\n      \"nodes\": [\n            48**\n      ],\n      \"edges\": {}\n}",
          "Msg": "归档任务日志：2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023",
          "Status": 4,
          "TenantId": "5***",
          "TriggerType": 1,
          "Version": "1"
        }
      ],
      "NextFireTimeResult": {
        "CronFireType": "NOT_SET"
      },
      "PageIndex": 10,
      "PageSize": 20,
      "TempTableNameMap": {
        "803***": [
          "tmp_dms_21321_20230704144336_temp_test_check"
        ]
      }
    },
    "PluginParam": {
      "ArchiveMethod": "inner_oss",
      "DbSchema": "test",
      "Logic": true,
      "OrderAfter": [
        "delete"
      ],
      "RunMethod": "now",
      "SourceDatabaseId": 0,
      "TableIncludes": [
        {
          "TableName": "tm_insured_cb",
          "TableWhere": "id<1000或者gmt_create<'2023-05-14 16:00:57'"
        }
      ],
      "TableMapping": [
        "{\n                    \"schema\": \"oracle_info\",\n                    \"tarTb\": \"eoa_context_test\",\n                    \"tbPartKey\": [],\n                    \"oriTb\": \"eoa_context\",\n                    \"columns\": [\n                        {\n                            \"tName\": \"dbid_test\",\n                            \"oName\": \"dbid\"\n                        }\n                    ],\n                    \"dbPartKey\": [],\n                    \"customPk\": [\n                        \"id\"\n                    ]\n                }"
      ],
      "TargetInstanceId": "12***",
      "Variables": [
        "{\n                    \"name\": \"test\",\n                    \"pattern\": \"yyyy-MM-dd|-10d\"\n                }"
      ]
    },
    "PluginType": "DATA_ARCHIVE",
    "RelatedUserList": [
      0
    ],
    "RelatedUserNickList": [
      "publicyuhzou"
    ],
    "StatusCode": "processing",
    "StatusDesc": "正在执行工单任务。",
    "WorkflowInstanceId": 0,
    "WorkflowStatusDesc": "审批通过"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.