StopProjectsByLabel-阿里云帮助中心

This API pauses all running data migration or data synchronization tasks with a specified tag.

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:StopProjectsByLabel

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID of the label.	l_****

Response elements

Element	Type	Description	Example
	object	The response body.
Success	boolean	Whether the request succeeded.	true
ErrorDetail	object	The error details.
Code	string	The error code.	CM-RESOAT1111
Level	string	The severity of the error. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.	ERROR
Message	string	The error message.	A system error occurred.
ExtraContext	object	Contains values for the placeholders in the `Message` field.
	any	A value for a placeholder in the `Message` field.	null
MessageMcmsKey	string	The lookup key for the error message template.	null
MessageMcmsContext	object	Contains values for the placeholders in the message template that corresponds to `MessageMcmsKey`.
	string	A value for a placeholder in the message template that corresponds to `MessageMcmsKey`.	null
Reason	string	The cause of the error.	null
ReasonMcmsKey	string	The lookup key for the error cause template.	null
ReasonMcmsContext	object	An object that contains values for the placeholders in the reason template that corresponds to the `ReasonMcmsKey`.
	string	A value for a placeholder in the reason template that corresponds to the `ReasonMcmsKey`.	null
Proposal	string	The suggested solution.	Contact the administrator.
ProposalMcmsKey	string	The lookup key for the suggested solution template.	null
ProposalMcmsContext	object	An object that contains values for the placeholders in the proposal template that corresponds to the `ProposalMcmsKey`.
	string	A value for a placeholder in the proposal template that corresponds to the `ProposalMcmsKey`.	null
UpstreamErrorDetail	any	Details of an error from an upstream service. This is used to handle HTTP requests.	null
Code	string	The error code. This is a legacy field.	INNER_ERROR
Message	string	The error message. This is a legacy field.	A system error occurred.
Advice	string	The suggested solution. This is a legacy field.	Contact the administrator.
RequestId	string	The unique identifier for the request. If you need to contact support, provide this ID.	A595F34C-XXXX-5D0C-8DA8-B3ED76
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries that match the query.	140
Cost	string	The time, in seconds, it took to process the request.	1
Data	object	The results of the batch stop operation.
Total	integer	The total number of projects processed.	16
SucceedProjectIds	array	The IDs of projects that were successfully stopped.
	string	The ID of a project that was successfully stopped.	np_4w****
FailedProjectIds	array	The IDs of projects that failed to stop.
	string	The ID of a project that failed to stop.	np_3w****

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111\n",
    "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": "A595F34C-XXXX-5D0C-8DA8-B3ED76",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 140,
  "Cost": "1",
  "Data": {
    "Total": 16,
    "SucceedProjectIds": [
      "np_4w****"
    ],
    "FailedProjectIds": [
      "np_3w****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.