StopProjectModifyRecords

更新时间:
复制 MD 格式

This API stops a modification operation based on the modification record's ID.

Operation description

You can only stop modification records in the RUNNING or FAILED state. This action is irreversible.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:StopProjectModifyRecords

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Id

string

Yes

The ID of the modification record.

344000005

Response elements

Element

Type

Description

Example

object

The response body.

Success

boolean

Indicates whether the call was successful.

true

ErrorDetail

object

The error details.

Code

string

The error code. This parameter is deprecated.

INNER_ERROR

Level

string

The severity level of the error. Valid values: FATAL, ERROR, WARNING, and CRITICAL.

ERROR

Message

string

The error message. This parameter is deprecated.

A system error occurred.

ExtraContext

object

A key-value map for placeholders in the Message parameter.

any

The value for a specific placeholder.

null

MessageMcmsKey

string

The template key for the error message.

null

MessageMcmsContext

object

A key-value map for placeholders in the MessageMcmsKey template.

string

The value for a specific placeholder in the template.

null

Reason

string

The reason for the error.

null

ReasonMcmsKey

string

The template key for the error reason.

null

ReasonMcmsContext

object

A key-value map for placeholders in the ReasonMcmsKey template.

string

The value for a specific placeholder in the template.

null

Proposal

string

A suggested action.

Contact the administrator.

ProposalMcmsKey

string

The template key for the suggested action.

null

ProposalMcmsContext

object

A key-value map for placeholders in the ProposalMcmsKey template.

string

The value for a specific placeholder in the template.

null

UpstreamErrorDetail

any

Details of the error from an upstream service.

null

Code

string

The error code. This parameter is deprecated.

INNER_ERROR

Message

string

The error message. This parameter is deprecated.

A system error occurred.

Advice

string

A suggested action.

Contact the administrator.

RequestId

string

The ID of the request.

EE205C00-30E4-****-****-87E3A8A2AA0C

PageNumber

integer

The page number of the returned results.

1

PageSize

integer

The number of entries returned per page.

10

TotalCount

integer

The total number of entries that match the query.

100

Cost

string

The request processing time, in seconds.

30

Data

any

The requested data.

null

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "INNER_ERROR",
    "Level": "ERROR",
    "Message": "A system error occurred.",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "Contact the administrator.",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator.",
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "Cost": "30",
  "Data": "null"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.