All Products
Search
Document Center

ENS:DistApplicationData

Last Updated:Nov 18, 2024

Distributes pushed data to the Edge Node Service (ENS) instances of the application. You can specify multiple canary release policies, decompress files, and restart containers.

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application. To obtain the application ID, call the ListApplications operation.

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

The list of data files that you want to distribute. The value must be a JSON string.

[{\"name\":\"app01\", \"version\":\"1.0\", \"destPath\":\"/root/installed\", \"decompress\":true, \"targetDirName\":\"target01\", \"fileMode\":755, \"timeout\":1000 }, { \"name\":\"app02\", \"version\":\"1.1\", \"destPath\":\"/tmp/test.txt\", \"decompress\":false }]
DistStrategystringNo

The canary release policy. The value must be a JSON string. You can specify multiple distribution policies. By default, all data files are distributed.

{\"name\":\"ScheduleToAllByMatchExpressions\",\"parameters\":{\"match_expressions\":[{\"key\":\"region_id\",\"operator\":\"In\",\"values\":[\"cn-wuhan-telecom_unicom_cmcc-2\"]}]}}

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
DistInstanceTotalCountinteger

The total number of ENS instance IDs.

2
DistInstanceIdsarray

The list of ENS instance IDs.

DistInstanceIdstring

The ID of the instance.

i-xxx
DistResultsarray<object>

The distribution result of the data file.

DistResultobject
ResultDescripstring

The description of the distribution result.

Success
Versionstring

The version number of the data file.

standard
ResultCodeinteger

The error code. The value is of the enumerated data type.

400
Namestring

The name of the data file.

gcs-prod-websocket-eip-unicom

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "DistInstanceTotalCount": 2,
  "DistInstanceIds": {
    "DistInstanceId": [
      "i-xxx"
    ]
  },
  "DistResults": {
    "DistResult": [
      {
        "ResultDescrip": "Success",
        "Version": "standard",
        "ResultCode": 400,
        "Name": "gcs-prod-websocket-eip-unicom"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
No change history