DescribeDataSourceInstance - Security Center - Alibaba Cloud Documentation Center

Queries the details of a data source.

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-sas:DescribeDataSourceInstance

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DataSourceInstanceId	string	Yes	The ID of the data source. The threat analysis service generates the ID by calculating the MD5 hash of specific parameters. Call the ListDataSourceLogs operation to obtain the data source ID.	220ba97c9d1fdb0b9c7e8c7ca328d7ea
AccountId	string	Yes	The ID of the Alibaba Cloud account.	123xxxxxxx
CloudCode	string	Yes	The code for the multicloud environment. Valid values: qcloud: Tencent Cloud. aliyun: Alibaba Cloud. hcloud: Huawei Cloud.	hcloud
RegionId	string	No	The region where the Data Management center of the threat analysis service is located. Select a region based on the region where your assets are located. Valid values: cn-hangzhou: Your assets are in the Chinese mainland or China (Hong Kong). ap-southeast-1: Your assets are in a region outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	CloudSiemSuccessResponse
Data	object	The data returned.
DataSourceInstanceId	string	The ID of the data source. The threat analysis service generates the ID by calculating the MD5 hash of specific parameters.	220ba97c9d1fdb0b9c7e8c7ca328d7ea
DataSourceInstanceParams	array<object>	The list of detailed parameters for the data source.
	object
ParaCode	string	The parameter code.	region_code
ParaValue	string	The parameter value.	ap-guangzhou
AccountId	string	The ID of the Alibaba Cloud account.	123xxxxxxx
CloudCode	string	The code for the multicloud environment. Valid values: qcloud: Tencent Cloud. aliyun: Alibaba Cloud. hcloud: Huawei Cloud.	hcloud
RequestId	string	The ID of the request.	6276D891-***-55B2-87B9-74D413F7**

Examples

Success response

JSON format

{
  "Data": {
    "DataSourceInstanceId": "220ba97c9d1fdb0b9c7e8c7ca328d7ea",
    "DataSourceInstanceParams": [
      {
        "ParaCode": "region_code",
        "ParaValue": "ap-guangzhou"
      }
    ],
    "AccountId": "123xxxxxxx",
    "CloudCode": "hcloud"
  },
  "RequestId": "6276D891-*****-55B2-87B9-74D413F7****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.