文档

DescribeDataSourceParameters - 获取数据源参数详情

更新时间:

获取数据源参数详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeDataSourceParametersget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DataSourceTypestring

接入的数据源类型。取值:

  • ckafka:腾讯云 ckafka。
  • obs:华为云 obs。
  • wafApi:腾讯云 waf 攻击日志下载 api。
obs
CloudCodestring

多云的 code。

hcloud
RegionIdstring

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港
  • ap-southeast-1:资产属于海外地域
cn-hangzhou

返回参数

名称类型描述示例值
object

CloudSiemSuccessResponse<List>

Dataarray<object>

请求返回值。

object

请求返回值。

DataSourceTypestring

数据源类型。取值:

  • obs:华为云 obs。
  • wafApi:腾讯云 waf 下载 api。
  • ckafka: 腾讯云 ckafka。
obs
ParaLevelinteger

参数级别。取值:

  • 1:数据源参数。
  • 2:日志参数。
1
ParaCodestring

参数 code。

region_code
ParaNamestring

参数名字。

region local
ParaTypestring

参数类型。

string
Requiredinteger

是否必选参数。取值:

  • 1:必选。
  • 0:非必选。
string
FormatCheckstring

格式校验方式。

email
Titlestring

参数值提示。

obs bucket name
Hitstring

更多说明。

obs docment
DefaultValuestring

默认参数值。

wafApi
Disabledboolean

是否禁止修改。取值:

  • true:禁止修改。
  • false:可以修改。
wafApi
CanEdittedinteger

是否可编辑。取值:

  • 0:禁止修改。
  • 1:可以修改。
wafApi
ParamValuearray<object>

具体的参数列表。

object

参数值。

Labelstring

展示内容。

guangzhou
Valuestring

实际的参数内容。

ap-guangzhou
CloudCodestring

多云的 code。取值:

  • qcloud:腾讯云。
  • aliyun:阿里云。
  • hcloud:华为云。
hcloud
RequestIdstring

请求消息 ID。

6276D891-*****-55B2-87B9-74D413F7****

示例

正常返回示例

JSON格式

{
  "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****"
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试

访问错误中心查看更多错误码。