Domain name for API request: sqlserver.tencentcloudapi.com.
This API is used to start and stop an extended event.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: StartInstanceXEvent. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID |
EventConfig.N | Yes | Array of EventConfig | Whether to start or stop an extended event |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to start and stop an extended event.
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartInstanceXEvent
<Common request parameters>
{
"InstanceId": "mssql-77auaua",
"EventConfig": [
{
"EventType": "slow",
"Threshold": 0
}
]
}
{
"Response": {
"RequestId": "AH7AAJ_909AA_AAAQ_2134343"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.DBError | Database error. |
FailedOperation.GcsError | The operation failed or the network timed out. |
InvalidParameter.InputIllegal | Input error. |
InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
ResourceNotFound.InstanceNotFound | The instance does not exist. |
ResourceNotFound.ParamsNotFound | Parameter not found. |
ResourceUnavailable.InstanceStatusInvalid | Invalid instance status. |
Was this page helpful?