All Products
Search
Document Center

Enterprise Distributed Application Service:UpdateHookConfiguration

Last Updated:Jan 08, 2024

Mounts a script to an application or application instance group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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
edas:ManageApplicationWrite
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/app/config_app_hook_json

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

d498****-1dd8ec229862
GroupIdstringNo

The ID of the application instance group.

d498****-1dd8ec229862
HooksstringYes

The script to mount. Set the value in the JSON format. Example: [{"ignoreFail":false,"name":"postprepareInstanceEnvironmentOnScaleOut","script":"ls"},{"ignoreFail":true,"name":"postdeleteInstanceDataOnScaleIn","script":""},{"ignoreFail":true,"name":"prestartInstance","script":""},{"ignoreFail":true,"name":"poststartInstance","script":""},{"ignoreFail":true,"name":"prestopInstance","script":""},{"ignoreFail":true,"name":"poststopInstance","script":""}]

[{"ignoreFail":false,"name":"postprepareInstanceEnvironmentOnScaleOut","script":"ls"}]

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The message that is returned.

success
RequestIdstring

The ID of the request.

d498****-1dd8ec229862
HooksConfigurationobject []

The information about the mounted script.

IgnoreFailboolean

Indicates whether a mount failure is ignored. Valid values:

  • true: A mount failure is ignored.
  • false: A mount failure is not ignored.
true
Namestring

The name of the mounted script.

postprepareInstanceEnvironmentOnScaleOut
Scriptstring

The content of the mounted script.

ls

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "d498****-1dd8ec229862",
  "HooksConfiguration": [
    {
      "IgnoreFail": true,
      "Name": "postprepareInstanceEnvironmentOnScaleOut",
      "Script": "ls"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.No permissions

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