All Products
Search
Document Center

Data Management:GetDataArchiveCount

Last Updated:Nov 28, 2024

Queries the statistics on the number of data archiving tickets, including the number of tickets of successful data archiving, failed data archiving,and in-progress data archiving, and the total number of data archiving tickets.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetDataArchiveCountnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PluginTypestringNo

The plugin type. Default value: DATA_ARCHIVE.

DATA_ARCHIVE
OrderResultTypestringNo

The type of the identity. Default value: AS_ADMIN.

AS_ADMIN
SearchDateTypestringNo

The time when the ticket is modified or created. The statistics of data archiving tickets are calculated based on the creation time.

CREATE_TIME
TidlongNo

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 parameters

ParameterTypeDescriptionExample
object
Dataobject

The data returned.

FailCountlong

The number of tickets that data archiving failed.

1**
ProcessingCountlong

The number of tickets that data archiving is in progress.

2**
SuccessCountlong

The number of tickets that data archiving is successful.

3**
TotalCountlong

The total number of data archiving tickets.

6**
Successboolean

Indicates whether the request is successful. Valid values:

  • true
  • false
true
RequestIdstring

The request ID.

4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.