Tüm Ürünler
Search
Belge Merkezi

:CreateGetDBListFromAgentTask

Son Güncelleme:Sep 30, 2026

Yedekleme ağ geçidi kullanarak bir veritabanı listesi almak için bir görev oluşturur.

Operation description

Bu API işlemi bir görev kimliği döndürür. Görev sonucunu görev kimliğine göre sorgulamak için GetDBListFromAgent işlemini çağırabilirsiniz.

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

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

BackupGatewayId

integer

No

Yedekleme ağ geçidinin kimliği. Kimliği sorgulamak için DescribeBackupPlanList işlemini çağırabilirsiniz.\n\n> Bu parametre gereklidir.

160813

DatabaseType

string

No

Veritabanının türü. Geçerli değerler:\n\n- MySQL\n\n- MSSQL\n\n- Oracle\n\n- MariaDB\n\n- PostgreSQL\n\n- DRDS\n\n- MongoDB\n\n- Redis

MySQL

SourceEndpointRegion

string

No

Yedekleme ağ geçidinin bulunduğu bölge.

cn-hangzhou

SourceEndpointIP

string

No

Veritabanına erişmek için kullanılan URL.

123.0.XX.XX

SourceEndpointPort

integer

No

Veritabanına bağlanmak için kullanılan bağlantı noktası.

3306

ClientToken

string

No

İsteğin idempotansını sağlamak için kullanılan istemci belirteci. Değeri oluşturmak için istemciyi kullanabilirsiniz, ancak farklı istekler arasında benzersiz olduğundan emin olmalısınız. Belirteç yalnızca ASCII karakterleri içerebilir ve uzunluğu 64 karakteri aşamaz.

ETnLKlblzczshOTUbOCzxxxxxxxxxx

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

Döndürülen HTTP durum kodu.

400

RequestId

string

İstek kimliği.

EB4DFD5E-3618-498D-BE35-4DBEA0072122

ErrCode

string

Hata kodu.

InvalidParameter

Success

boolean

İsteğin başarılı olup olmadığını gösterir.

true

ErrMessage

string

Hata mesajı.

This backupPlan can't support this action

TaskId

integer

Zaman uyumsuz görevin kimliği.

123456

Examples

Success response

JSON format

{
  "HttpStatusCode": 400,
  "RequestId": "EB4DFD5E-3618-498D-BE35-4DBEA0072122",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "This backupPlan can't support this action",
  "TaskId": 123456
}

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.