DocsICP FilingConsole
官方文档
首页

DescribeInstanceSources

更新时间：
复制 MD 格式
产品详情
我的收藏

Queries a list of data assets.

Operation description

Queries the list of authorized or unauthorized data assets based on the AuthStatus parameter to help you understand the authorization status of your data assets.

This operation is no longer used in the new console.

QPS limit

Each user can call this operation up to 10 times per second. If this limit is exceeded, API calls are throttled, which may affect your business.

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

yundun-sddp:DescribeInstanceSources

get

*All Resource

*
  • acs:ResourceGroupId
 None

Request parameters

Parameter

Type

Required

Description

Example
Lang

string

No

The language of the request and response. Valid values:

  • zh_cn: Simplified Chinese. This is the default value.

  • en_us: English.

zh_cn
PageSize

integer

No

The number of entries per page in a paginated query. Default value: 10.

10
CurrentPage

integer

No

The page number. Default value: 1.

1
ServiceRegionId

string

No

The region where the asset is located. For more information, see Supported regions.

cn-hangzhou
EngineType

string

No

The database engine type. Valid values:

  • MySQL

  • MariaDB

  • Oracle

  • PostgreSQL

  • SQLServer

MySQL
InstanceId

string

No

The instance ID.

instance-demo-****
ProductId

integer

No

The product type ID to query. Valid values:

  • 1: MaxCompute

  • 2: OSS

  • 3: ADS

  • 4: OTS

  • 5: RDS

  • 6: SELF_DB

1
ProductCode

string

No

The name of the product to query. Valid values: MaxCompute, OSS, ADS, OTS, and RDS.

MaxCompute
AuditStatus

integer

No

The audit status. Valid values:

  • 1: Auditing is enabled.

  • 0: Auditing is disabled.

1
SearchType

string

No

The type of the fuzzy search for data assets. Valid values:

  • InstanceId: The instance ID.

  • InstanceName: The instance name.

  • DatabaseName: The database name.

InstanceId
SearchKey

string

No

The keyword for the fuzzy search of data assets.

1
AuthStatus

integer

No

The authorization status of the data asset instance.

  • 0: Unauthorized.

  • 1: Authorized.

0
FeatureType

integer

No

This parameter is deprecated.

1

Response elements

Element

Type

Description

Example

object

CurrentPage

integer

The page number.

1
RequestId

string

The request ID.

5A7E8FB9-5011-5A90-97D9-AE587047****
PageSize

integer

The number of entries per page.

10
TotalCount

integer

The total number of assets.

2
Items

array<object>

A list of assets.

object

A list of assets.

LastModifyUserId

string

The ID of the account that last modified the asset.

demo
PasswordStatus

integer

The status of the password. Valid values:

  • 1: In use.

  • 0: Not in use.

1
EngineType

string

The database engine type. Valid values:

  • MySQL

  • MariaDB

  • Oracle

  • PostgreSQL

  • SQLServer

MySQL
TenantName

string

The name of the tenant.

user1
InstanceId

string

The instance ID.

rm-****
InstanceDescription

string

The description of the instance.

instance test
RegionId

string

The region ID.

cn-hangzhou
DbName

string

The name of the database to which the asset belongs.

demo
LastModifyTime

integer

The timestamp when the asset was last modified. Unit: milliseconds.

1625587423000
RegionName

string

The name of the region.

cn-hangzhou
CanModifyUserName

boolean

Indicates whether the username and password can be modified. Valid values:

  • true: Yes.

  • false: No.

true
LogStoreDay

integer

The storage duration of raw logs. Unit: days.

30
GmtCreate

integer

The time when the asset was created. This value is a UNIX timestamp. Unit: milliseconds.

1625587423000
AutoScan

integer

Indicates whether automatic scanning for sensitive data is enabled. Valid values:

  • 0: Disabled.

  • 1: Enabled.

0
ProductId

integer

The product type ID. Valid values:

  • 1: MaxCompute

  • 2: OSS

  • 3: ADS

  • 4: OTS

  • 5: RDS

  • 6: SELF_DB

2
InstanceSize

integer

The size of the instance. This parameter is valid only for OSS assets. Unit: bytes.

409600
UserName

string

The username of the account.

User01
AuditStatus

integer

The audit authorization status. Valid values:

  • 1: Authorized.

  • 0: Unauthorized.

1
Id

integer

The unique ID of the asset.

1
TenantId

string

The tenant ID.

11
Enable

integer

Indicates whether sensitive data detection is enabled for the asset. Valid values:

  • 1: Enabled.

  • 0: Disabled.

1
CheckStatus

integer

The data check status. Valid values:

  • 0: Ready.

  • 1: Running.

  • 2: Connectivity test in progress.

  • 3: Connectivity test passed.

  • 4: Connectivity test failed.

3
DatamaskStatus

integer

The status of data masking authorization. Valid values:

  • 1: Enabled.

  • 0: Disabled.

1
ErrorMessage

string

The reason for the failure.

password error
SamplingSize

integer

The sensitive data sampling size. Valid values: 0, 5, and 10. Unit: number of entries.

10

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "5A7E8FB9-5011-5A90-97D9-AE587047****",
  "PageSize": 10,
  "TotalCount": 2,
  "Items": [
    {
      "LastModifyUserId": "demo",
      "PasswordStatus": 1,
      "EngineType": "MySQL",
      "TenantName": "user1",
      "InstanceId": "rm-****",
      "InstanceDescription": "instance test",
      "RegionId": "cn-hangzhou",
      "DbName": "demo",
      "LastModifyTime": 1625587423000,
      "RegionName": "cn-hangzhou",
      "CanModifyUserName": true,
      "LogStoreDay": 30,
      "GmtCreate": 1625587423000,
      "AutoScan": 0,
      "ProductId": 2,
      "InstanceSize": 409600,
      "UserName": "User01",
      "AuditStatus": 1,
      "Id": 1,
      "TenantId": "11",
      "Enable": 1,
      "CheckStatus": 3,
      "DatamaskStatus": 1,
      "ErrorMessage": "password error",
      "SamplingSize": 10
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.