DescribeDLAService - Data Management - Alibaba Cloud Documentation Center

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

dbs:DescribeDLAService

get

*All Resource

*

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.	dbstooi01exXXXX
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	DBS

Response elements

Element	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

Success response

JSON format

{
  "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	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.