DescribeActiveOperationTasks - PolarDB - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeActiveOperationTasks	The operation that you want to perform. Set the value to DescribeActiveOperationTasks.
Region	String	No	cn-hangzhou	The region in which the instance whose O&M events you want to query is located.
TaskType	String	No	all	The type of the O&M events that you want to query. The value all indicates that all O&M events configured by the account are listed. Set the value to all.
ProductId	String	No	polarx	The name of the service. Default value: polarx.
DbType	String	No	polarx	The type of the database. Set the value to polarx.
InsName	String	No	pxc-xxxxx	The name of the instance whose O&M events you want to query. By default, the value of this parameter is an empty string.
ChangeLevel	String	No	all	The change levels of O&M events that you want to query. Default value: all. Valid values: all: O&M Events that are executed for exception fixing and regular O&M are all returned. S0: O&M events that are executed for exception fixing are returned. S1: O&M events that are executed for regular O&M are returned.
PageSize	Long	No	25	The number of O&M events to return on each page. Default value: 25.
PageNumber	Long	No	1	The number of the page to return. Pages start from page 1. Default value: 1.
Status	Long	No	-1	The status of the O&M events that you want to query. Valid values: -1: O&M events that are being executed and to be executed are all returned. 3: O&M events that are to be executed are returned. 4: O&M events that are to be executed are returned.
AllowChange	Long	No	-1	Determines whether the time of the returned O&M events is allowed to be modified. Valid values: -1: The time of all O&M events can be modified. 0: The time of returned O&M events cannot be modified. 1: The time of returned O&M events can be modified.
AllowCancel	Long	No	-1	Determines whether the returned O&M events are allowed to be canceled. Valid values: -1: All O&M events can be canceled. 0: The returned O&M events cannot be canceled. 1: The returned O&M events can be canceled.
RegionId	String	Yes	cn-hangzhou	The ID of region in which the instance is located.

Response parameters


Parameter	Type	Example	Description
PageSize	Long	12	The number of events returned on each page.
RequestId	String	xxxx	The ID of the request.
PageNumber	Long	1	The page number of the returned page.
TotalRecordCount	Long	23	The total number of returned events.
Items	Array of Items		The array of parameters.
AllowCancel	String	0	Indicates whether the returned O&M events are allowed to be canceled. 0: The returned O&M events cannot be canceled. 1: The returned O&M events can be canceled.
AllowChange	String	0	Indicates whether the returned O&M events can be modified. 0: The returned O&M events cannot be modified. 1: The returned O&M events can be modified.
ChangeLevel	String	Risk	The change level of the O&M events. (ignorable)
ChangeLevelEn	String	Risk repairment	The change level of the O&M events in English.
ChangeLevelZh	String	风险修复	The change level of the O&M events in Chinese.
CreatedTime	String	2021-06-15T16:00:00Z	The creation time of the O&M event.
CurrentAVZ	String	cn-shanghai-et-a	The current zone.
DbType	String	polarx	The database engine that runs on the instance.
DbVersion	String	2.0	The version of the database engine that runs on the instance.
Deadline	String	2021-06-15T16:00:00Z	The end time of the O&M event. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
Id	Long	1	The ID of the flashback task.
Impact	String	--	The impact of the O&M events. (not displayed)
ImpactEn	String	Transient instance disconnection	The impact of the O&M events in English.
ImpactZh	String	Interruption	The impact of the O&M events in Chinese.
InsComment	String	xxx	The description of the policy.
InsName	String	pxc-dd	The name of the instance.
ModifiedTime	String	2021-06-15T16:00:00Z	The time when the API was last modified.
PrepareInterval	String	03:00:00	The preparation time period for the O&M event.
Region	String	cn-shanghai-et15-b01	The region of the instance for which the requested O&M events are configured.
ResultInfo	String	--	The result information. (ignorable)
StartTime	String	2021-06-15T16:00:00Z	The time when the batch processing starts.
Status	Long	3	Valid values: 3: O&M events that are to be executed are returned. 4: O&M events that are being executed are returned.
SubInsNames	Array of String	pxc-xx	The names of subinstances.
SwitchTime	String	2021-06-15T16:00:00Z	The switching time of the O&M event. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
TaskType	String	rds_apsaradb_transfer	The type of the O&M event.
TaskTypeEn	String	--	The type of the O&M event in English. (ignorable)
TaskTypeZh	String	--	The type of the O&M event in Chinese. (ignorable)

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeActiveOperationTasks
&Region=cn-hangzhou
&TaskType=all
&ProductId=polarx
&DbType=polarx
&InsName=pxc-xxxxx
&ChangeLevel=all
&PageSize=25
&PageNumber=1
&Status=-1
&AllowChange=-1
&AllowCancel=-1
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeActiveOperationTasksResponse>
    <PageSize>12</PageSize>
    <RequestId>xxxx</RequestId>
    <PageNumber>1</PageNumber>
    <TotalRecordCount>23</TotalRecordCount>
    <Items>
        <AllowCancel>0</AllowCancel>
        <AllowChange>0</AllowChange>
        <ChangeLevel>Risk</ChangeLevel>
        <ChangeLevelEn>Risk repairment</ChangeLevelEn>
        <ChangeLevelZh>风险修复</ChangeLevelZh>
        <CreatedTime>2021-06-15T16:00:00Z</CreatedTime>
        <CurrentAVZ>cn-shanghai-et-a</CurrentAVZ>
        <DbType>polarx</DbType>
        <DbVersion>2.0</DbVersion>
        <Deadline>2021-06-15T16:00:00Z</Deadline>
        <Id>1</Id>
        <Impact>--</Impact>
        <ImpactEn>Transient instance disconnection</ImpactEn>
        <ImpactZh>中断</ImpactZh>
        <InsComment>xxx</InsComment>
        <InsName>pxc-dd</InsName>
        <ModifiedTime>2021-06-15T16:00:00Z</ModifiedTime>
        <PrepareInterval>03:00:00</PrepareInterval>
        <Region>cn-shanghai-et15-b01</Region>
        <ResultInfo>--</ResultInfo>
        <StartTime>2021-06-15T16:00:00Z</StartTime>
        <Status>3</Status>
        <SubInsNames>pxc-xx</SubInsNames>
        <SwitchTime>2021-06-15T16:00:00Z</SwitchTime>
        <TaskType>rds_apsaradb_transfer</TaskType>
        <TaskTypeEn>--</TaskTypeEn>
        <TaskTypeZh>--</TaskTypeZh>
    </Items>
</DescribeActiveOperationTasksResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 12,
  "RequestId" : "xxxx",
  "PageNumber" : 1,
  "TotalRecordCount" : 23,
  "Items" : [ {
    "AllowCancel" : "0",
    "AllowChange" : "0",
    "ChangeLevel" : "Risk",
    "ChangeLevelEn" : "Risk repairment",
    "ChangeLevelZh": "风险修复"
    "CreatedTime" : "2021-06-15T16:00:00Z",
    "CurrentAVZ" : "cn-shanghai-et-a",
    "DbType" : "polarx",
    "DbVersion" : "2.0",
    "Deadline" : "2021-06-15T16:00:00Z",
    "Id" : 1,
    "Impact" : "--",
    "ImpactEn" : "Transient instance disconnection",
    "ImpactZh": "中断"
    "InsComment" : "xxx",
    "InsName" : "pxc-dd",
    "ModifiedTime" : "2021-06-15T16:00:00Z",
    "PrepareInterval" : "03:00:00",
    "Region" : "cn-shanghai-et15-b01",
    "ResultInfo" : "--",
    "StartTime" : "2021-06-15T16:00:00Z",
    "Status" : 3,
    "SubInsNames" : [ "pxc-xx" ],
    "SwitchTime" : "2021-06-15T16:00:00Z",
    "TaskType" : "rds_apsaradb_transfer",
    "TaskTypeEn" : "--",
    "TaskTypeZh" : "--"
  } ]
}

Error codes


HttpCode	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	The error message returned because the request uses the same token that is used by a non-identical request. Only identical requests can use the same client token.

For a list of error codes, visit the API Error Center.