All Products
Search
Document Center

Security Center:DescribeDataSource

Last Updated:Nov 26, 2024

Queries data sources for DingTalk notifications. You can configure the types of alerts for which you want to use a DingTalk chatbot to send notifications based on the data sources.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeDataSourceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address.

39.155.*.*
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
ConfigTypestringNo

The method that is used to send alert notifications. Set the value to DingTalk.

DingTalk

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

7532B7EE-7CE7-5F4D-BF04-B12447DDXXXX
MetaDatasarray<object>

The metadata of the data sources.

Dataobject

The metadata of the data source.

Descriptionstring

The description of the data source.

dingtalk_suspicious
DataSourceNamestring

The name of the data source.

sas_analysis_pre-sas-operation-log-sas-event-suspicious
DataSourceIdinteger

The ID of the data source.

1753
MetaDataFieldsarray<object>

The metadata files.

MetaDataFieldobject

The metadata file.

ValueTypestring

The value type of the field.

string
Filedstring

The key of the field.

type
FiledNamestring

The name of the field.

dingtalk_vul_type
Samplestring

The sample field.

all:dingtalk_all;cms:dingtalk_vul_cms;oval:dingtalk_vul_cve;sys:dingtalk_vul_sys;emg:dingtalk_vul_emg
OperatorListarray<object>

The operators.

Operatorobject

The operator.

Descriptionstring

The description of the operator.

dingtalk_vul
Namestring

The name of the operator.

regex

Examples

Sample success responses

JSONformat

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DDXXXX",
  "MetaDatas": [
    {
      "Description": "dingtalk_suspicious",
      "DataSourceName": "sas_analysis_pre-sas-operation-log-sas-event-suspicious",
      "DataSourceId": 1753,
      "MetaDataFields": [
        {
          "ValueType": "string",
          "Filed": "type",
          "FiledName": "dingtalk_vul_type",
          "Sample": "all:dingtalk_all;cms:dingtalk_vul_cms;oval:dingtalk_vul_cve;sys:dingtalk_vul_sys;emg:dingtalk_vul_emg",
          "OperatorList": [
            {
              "Description": "dingtalk_vul",
              "Name": "regex"
            }
          ]
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.