Use DescribeDataPushResult to query the push status of application data files - ENS

You can invoke DescribeDataPushResult to obtain the pre-push status results of an application's data files on edge zones.

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

ens:DescribeDataPushResult

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	e76f8985-7965-41fc-925b-9648bb6bf650
DataNames	string	No	The name of the data file. Separate multiple names with commas (,). By default, all data files are queried.	159828628258496/mirror_file/game-2553efe7-7bf8-40fb-a6e7-09c9c00a992a.tar
DataVersions	string	No	The version number of the data file. Separate multiple numbers with commas (,). By default, all versions of data files are queried.	90396
MinDate	string	No	The beginning of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted.	2022-02-15
MaxDate	string	No	The end of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted.	2022-02-20
PageNumber	integer	No	Page number, starting from 1. This parameter can be omitted when exporting all information.	1
PageSize	integer	No	The number of entries per page. This parameter is optional if you want to return the push status of all data files.	10
RegionIds	string	No	The IDs of ENS nodes. Separate multiple IDs with commas (,). By default, all ENS nodes are queried.	cn-wuhan-telecom_unicom_cmcc-2,cn-jiaozuo-2

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
PushResults	object
PushResult	array<object>	The push results of data files.
	array<object>
Name	string	The name of the data file.	gcs-pre-websocket-eip-telecom
StatusStatS	object
StatusStat	array<object>	The push status of data files.
	array<object>
RegionIdCount	integer	The total number of ENS nodes.	2
RegionIds	object
RegionId	array<object>	The push status of data files on the ENS node.
	object
RegionId	string	The ID of the ENS node.	cn-wuxi-5
StartTime	string	The start time of the push operation. The time is displayed in UTC.	2021-12-28T16:00:00Z
StatusDescrip	string	The description of the status.	Success
UpdateTime	string	The time when the status was last updated. The time is displayed in UTC.	2021-12-07T02:37:10Z
Status	string	The push status. The value is of the enumeration type. Valid values: SUCCESS FAILED PUSHING	FAILED
Version	string	The version number of the data file.	standard
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	The total number of entries returned.	6

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "PushResults": {
    "PushResult": [
      {
        "Name": "gcs-pre-websocket-eip-telecom",
        "StatusStatS": {
          "StatusStat": [
            {
              "RegionIdCount": 2,
              "RegionIds": {
                "RegionId": [
                  {
                    "RegionId": "cn-wuxi-5",
                    "StartTime": "2021-12-28T16:00:00Z",
                    "StatusDescrip": "Success",
                    "UpdateTime": "2021-12-07T02:37:10Z"
                  }
                ]
              },
              "Status": "FAILED"
            }
          ]
        },
        "Version": "standard"
      }
    ]
  },
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 6
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	LimitExceeded.SecurityGroup	The number of securityGroup exceeds the limit.
400	ens.interface.error	An error occurred while calling the API.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.