DescribeDLAService - Database Backup - Alibaba Cloud Documentation Center

Queries the status of the Data Lake Analytics (DLA) service for a backup schedule.

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.

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.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:DescribeDLAService	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.	dbstooi01ex****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	DBS

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful.	true
State	string	The status of the DLA service for the backup schedule. Valid values: Running: DLA is running. Closing: DLA is being disabled. Closed: DLA is disabled.	Running
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
AutoAdd	boolean	Specifies whether to enable the feature of automatically adding incremental data to a data lake. If this feature is enabled, DBS adds the backup sets that are newly generated to the data lake that is created for the backup schedule. Valid values: true: enables the feature. false: disables the feature.	true
HaveJobFailed	boolean	Indicates whether a failed DLA task exists in the return result. Valid values: true: A failed DLA task exists. false: No failed DLA task exists.	false

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "State": "Running",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "AutoAdd": true,
  "HaveJobFailed": false
}

Error codes

HTTP status code	Error code	Error message
403	Request.Forbidden	Have no Permissions

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

Change history

Change time	Summary of changes	Operation

No change history