DescribeDataSourceParameters - Security Center - Alibaba Cloud Documentation Center

Describes the parameters for 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:DescribeDataSourceParameters

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DataSourceType	string	Yes	The type of the data source. Valid values: ckafka: Tencent Cloud CKafka. obs: Huawei Cloud OBS. wafApi: Tencent Cloud WAF attack log download API.	obs
CloudCode	string	Yes	The code for the multicloud environment.	hcloud
RegionId	string	No	The region where the Data Management center for threat analysis is deployed. 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 outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	CloudSiemSuccessResponse<List>
Data	array<object>	The data returned.
	object	The data returned.
DataSourceType	string	The type of the data source. Valid values: obs: Huawei Cloud OBS. wafApi: Tencent Cloud WAF download API. ckafka: Tencent Cloud CKafka.	obs
ParaLevel	integer	The level of the parameter. Valid values: 1: data source parameter. 2: log parameter.	1
ParaCode	string	The code of the parameter.	region_code
ParaName	string	The name of the parameter.	region local
ParaType	string	The type of the parameter.	string
Required	integer	Indicates whether the parameter is required. Valid values: 1: The parameter is required. 0: The parameter is optional.	string
FormatCheck	string	The format check method.	email
Title	string	The prompt for the parameter value.	obs bucket name
Hit	string	Additional information.	obs docment
DefaultValue	string	The default value of the parameter.	wafApi
Disabled	boolean	Indicates whether the parameter can be modified. Valid values: true: The parameter cannot be modified. false: The parameter can be modified.	wafApi
CanEditted	integer	Indicates whether the parameter is editable. Valid values: 0: The parameter cannot be modified. 1: The parameter can be modified.	wafApi
ParamValue	array<object>	The list of parameters.
	object	The parameter value.
Label	string	The displayed content.	guangzhou
Value	string	The actual value of the parameter.	ap-guangzhou
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": [
    {
      "DataSourceType": "obs",
      "ParaLevel": 1,
      "ParaCode": "region_code",
      "ParaName": "region local",
      "ParaType": "string",
      "Required": 0,
      "FormatCheck": "email",
      "Title": "obs bucket name",
      "Hit": "obs docment",
      "DefaultValue": "wafApi",
      "Disabled": true,
      "CanEditted": 0,
      "ParamValue": [
        {
          "Label": "guangzhou",
          "Value": "ap-guangzhou"
        }
      ],
      "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.