Query data file distribution status with DescribeDataDistResult - ENS

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

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:DescribeDataDistResult

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.	cloudgame-shanghai/deploy_app/20220215/1644895216305ACG_M21B-ota-1.1.2-D-0215.0628_V1_0002-pre-weiduan.zip
DataVersions	string	No	The version number of the data file. Separate multiple numbers with commas (,). By default, all versions of data files are queried.	4885
InstanceIds	string	No	The IDs of ENS instances. Separate multiple IDs with commas (,). By default, all instances are queried.	i-7ecpqvkicnchxccozrp,i-6ecpqvkicnchxccozrp
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-01-02
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-01
PageNumber	integer	No	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
PageSize	integer	No	The number of entries per page. This parameter is optional if you want to return the distribution status of all data files.	10
EnsRegionIds	array	No	The IDs of the ENS nodes.
	string	No	The ID of the ENS node.	[\"cn-xiangyang-19\"]

Response elements

Element	Type	Description	Example
	object
DistResults	object
DistResult	array<object>	The distribution status of data files on edge instances.
	array<object>	The data distribution status of edge resource instances.
Name	string	The name of the data file.	gcs-prod-websocket-eip-unicom
StatusStats	object
StatusStat	array<object>	The distribution status statistics.
	array<object>
InstanceCount	string	The number of associated edge instances.	10
Instances	object
Instance	array<object>	The distribution status of the edge instance.
	object	The distribution status of edge resource instances.
InstanceId	string	The ID of the instance	i-5qzje8f5un1wmi341m2yetaxv
StartTime	string	The start time of the distribution. The time is displayed in UTC.	2021-11-19T07:24:52Z
StatusDescrip	string	The description of the distribution status.	Success
UpdateTime	string	The time when the distribution status was last updated. The time is displayed in UTC.	2021-10-11T02:38:19Z
Status	string	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
Version	string	The version number of the data file.	standard
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The ID of the request.	50373E71-7710-4620-8AAB-133CCE49451C
TotalCount	integer	The total number of entries returned.	49

Examples

Success response

JSON format

{
  "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",
                    "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 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.