调用CreateRecommendationTask接口为MongoDB实例创建索引分析任务。

调用该接口时,实例必须满足以下条件:

  • 实例的地域为华东1、华东2、华南1、华北1或华北2。
  • 实例类型为副本集实例或分片集群实例。
  • 实例已开通审计日志功能。
说明
  • 调用本接口创建索引分析任务后,可以通过调用DescribeAvailableTimeRange查询对应的任务及状态。
  • 每个实例每日最多可执行10次。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateRecommendationTask

要执行的操作,取值:CreateRecommendationTask

StartTime String 2019-01-01T12Z

查询开始时间,格式为yyyy-MM-ddTHHZ(UTC时间)。

说明 StartTime参数取值必须晚于审计日志的开启时间。
EndTime String 2019-01-01T18Z

查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHHZ(UTC时间)。

说明 查询的时间范围为7天内。
InstanceId String dds-bpxxxxxxxx

实例ID。

说明 当本参数传入的是分片集群实例ID时,还需要传入 NodeId参数。
NodeId String d-bpxxxxxxxx

分片集群实例中Shard节点ID。

说明DBInstanceId参数传入的是分片集群实例ID时,本参数才可用。
RegionId String cn-hangzhou

实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。

AccessKeyId String LTAIgbTGpxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
RequestId String 009D2572-6839-43C0-8D89-44DB46CBA2EA

请求ID。

示例

请求示例


http(s)://mongodb.aliyuncs.com/?Action=CreateRecommendationTask
&StartTime=2019-01-01T12Z
&EndTime=2019-01-01T18Z
&InstanceId=dds-bpxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<CreateRecommendationTaskResponse>
	  <RequestId>009D2572-6839-43C0-8D89-44DB46CBA2EA</RequestId>
</CreateRecommendationTaskResponse>

JSON 格式

{
	"RequestId":"009D2572-6839-43C0-8D89-44DB46CBA2EA"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidEndTime.Format Specified end time is not valid. 输入的结束时间无效,请您检查输入的时间格式是否正确。

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