All Products
Search
Document Center

ENS:DescribeDataDistResult

Last Updated:Nov 18, 2024

Queries the distribution status of data files on edge instances of an application.

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:DescribeDataDistResultget
*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.

cloudgame-shanghai/deploy_app/20220215/1644895216305ACG_M21B-ota-1.1.2-D-0215.0628_V1_0002-pre-weiduan.zip
DataVersionsstringNo

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

4885
InstanceIdsstringNo

The IDs of ENS instances. Separate multiple IDs with commas (,). By default, all instances are queried.

i-7ecpqvkicnchxccozrp,i-6ecpqvkicnchxccozrp
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-01-02
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-01
PageNumberintegerNo

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

1
PageSizeintegerNo

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

10
EnsRegionIdsarrayNo

The IDs of the ENS nodes.

stringNo

The ID of the ENS node.

[\"cn-xiangyang-19\"]

Response parameters

ParameterTypeDescriptionExample
object
DistResultsarray<object>

The distribution status of data files on edge instances.

DistResultobject

The data distribution status of edge resource instances.

Namestring

The name of the data file.

gcs-prod-websocket-eip-unicom
StatusStatsarray<object>

The distribution status statistics.

StatusStatobject
InstanceCountstring

The number of associated edge instances.

10
Instancesarray<object>

The distribution status of the edge instance.

Instanceobject

The distribution status of edge resource instances.

InstanceIdstring

The ID of the instance

i-5qzje8f5un1wmi341m2yetaxv
StartTimestring

The start time of the distribution. The time is displayed in UTC.

2021-11-19T07:24:52Z
StatusDescripstring

The description of the distribution status.

SUCCESS
UpdateTimestring

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

2021-10-11T02:38:19Z
Statusstring

The distribution status. The value is of the enumeration type. Valid values:

  • SUCCESS: The distribution is successful.
  • FAILED: The distribution failed.
  • DISTING: The data is being distributed.
  • POD_RESTARTING: The idle pod is being restarted.
  • DELETED: The data is cleared or removed.
SUCCESS
Versionstring

The version number of the data file.

standard
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The ID of the request.

50373E71-7710-4620-8AAB-133CCE49451C
TotalCountinteger

The total number of entries returned.

49

Examples

Sample success responses

JSONformat

{
  "DistResults": {
    "DistResult": [
      {
        "Name": "gcs-prod-websocket-eip-unicom",
        "StatusStats": {
          "StatusStat": [
            {
              "InstanceCount": "10",
              "Instances": {
                "Instance": [
                  {
                    "InstanceId": "i-5qzje8f5un1wmi341m2yetaxv",
                    "StartTime": "2021-11-19T07:24:52Z",
                    "StatusDescrip": "SUCCESS\n",
                    "UpdateTime": "2021-10-11T02:38:19Z"
                  }
                ]
              },
              "Status": "SUCCESS"
            }
          ]
        },
        "Version": "standard"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "50373E71-7710-4620-8AAB-133CCE49451C",
  "TotalCount": 49
}

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
2023-12-21API Description Update. The Error code has changedView Change Details
2023-03-02The Error code has changed. The request parameters of the API has changedView Change Details