GetDataArchiveCount API Overview - Data Management - Alibaba Cloud - Data Management

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

dms:GetDataArchiveCount

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PluginType	string	No	The plugin type. Default value: DATA_ARCHIVE.	DATA_ARCHIVE
OrderResultType	string	No	The type of the identity. Default value: AS_ADMIN.	AS_ADMIN
SearchDateType	string	No	The time condition for filtering tickets: modification time or creation time. Archiving statistics are calculated based on the creation time.	CREATE_TIME
Tid	integer	No	The tenant ID. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	2****

Response elements

Element	Type	Description	Example
	object
Data	object	The data returned.
FailCount	integer	The number of failed data archiving tickets.	12
ProcessingCount	integer	The number of in-progress data archiving tickets.	180
SuccessCount	integer	The number of successful data archiving tickets.	900
TotalCount	integer	The total number of data archiving tickets.	1400
Success	boolean	Indicates whether the request is successful. Valid values: true false	true
RequestId	string	The request ID.	4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2

Examples

Success response

JSON format

{
  "Data": {
    "FailCount": 12,
    "ProcessingCount": 180,
    "SuccessCount": 900,
    "TotalCount": 1400
  },
  "Success": true,
  "RequestId": "4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.