All Products
Search
Document Center

ENS:DescribeDataPushResult

Last Updated:Nov 18, 2024

Queries the push status of application data files on Edge Node Service (ENS) nodes.

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
ens:DescribeDataPushResultget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

e76f8985-7965-41fc-925b-9648bb6bf650
DataNamesstringNo

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
DataVersionsstringNo

The version number of the data file. Separate multiple numbers with commas (,). By default, all versions of data files are queried.

90396
MinDatestringNo

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
MaxDatestringNo

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
PageNumberintegerNo

The page number. Pages start from page 1. This parameter is optional if you want to return the push status of all data files.

1
PageSizeintegerNo

The number of entries per page. This parameter is optional if you want to return the push status of all data files.

10
RegionIdsstringNo

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 parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
PushResultsarray<object>

The push results of data files.

PushResultobject
Namestring

The name of the data file.

gcs-pre-websocket-eip-telecom
StatusStatSarray<object>

The push status of data files.

StatusStatobject
RegionIdCountinteger

The total number of ENS nodes.

2
RegionIdsarray<object>

The push status of data files on the ENS node.

RegionIdobject
RegionIdstring

The ID of the ENS node.

cn-wuxi-5
StartTimestring

The start time of the push operation. The time is displayed in UTC.

2021-12-28T16:00:00Z
StatusDescripstring

The description of the status.

Success
UpdateTimestring

The time when the status was last updated. The time is displayed in UTC.

2021-12-07T02:37:10Z
Statusstring

The push status. The value is of the enumeration type. Valid values: SUCCESS FAILED PUSHING

FAILED
Versionstring

The version number of the data file.

standard
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCountinteger

The total number of entries returned.

6

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400LimitExceeded.SecurityGroupThe number of securityGroup exceeds the limit.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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

Change history

Change timeSummary of changesOperation
2024-03-12API Description Update. The Error code has changedView Change Details