StartProjectsByLabel-阿里云帮助中心

This API starts all unstarted data migration or data synchronization tasks under a specific 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:StartProjectsByLabel

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	Indicates whether the request was successful.	true
ErrorDetail	object	The error details.
Code	string	The error code.	CM-RESOAT1111
Level	string	The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.	ERROR
Message	string	The error message.	A system error occurred.
ExtraContext	object	Specifies data for the placeholders in the `Message` parameter.
	any	The data for a placeholder in the `Message` parameter.	null
MessageMcmsKey	string	The MCMS key for the error message.	null
MessageMcmsContext	object	Specifies data for placeholders in the message template identified by `MessageMcmsKey`.
	string	The data for a placeholder in the template.	null
Reason	string	The reason for the error.	null
ReasonMcmsKey	string	The key for the error cause.	null
ReasonMcmsContext	object	The context for the error cause.
	string	The data for a placeholder in the reason template.	null
Proposal	string	The suggested solution.	null
ProposalMcmsKey	string	The key for the proposal content.	null
ProposalMcmsContext	object	The context for the proposal content.
	string	The data for a placeholder in the proposal template.	null
UpstreamErrorDetail	any	The details of an error from an upstream service.	null
Code	string	A legacy error code for backward compatibility.	INNER_ERROR
Message	string	A legacy error message for backward compatibility.	A system error occurred.
Advice	string	A legacy suggestion for backward compatibility.	Contact the administrator.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	The page number. Returned only for paginated queries.	1
PageSize	integer	The number of entries per page. Returned only for paginated queries.	10
TotalCount	integer	The total number of entries. Returned only for paginated queries.	79
Cost	string	The request duration, in seconds.	1
Data	object	Details about the projects.
Total	integer	The total number of projects processed.	20
SucceedProjectIds	array	A list of IDs of projects that were successfully started.
	string	The ID of a project that was successfully started.	np_4w****
FailedProjectIds	array	A list of IDs of projects that failed to start.
	string	The ID of a project that failed to start.	np_3w****

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111",
    "Level": "ERROR",
    "Message": "A system error occurred.\n",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "null",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.\n",
  "Advice": "Contact the administrator. ",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 79,
  "Cost": "1",
  "Data": {
    "Total": 20,
    "SucceedProjectIds": [
      "np_4w****\n"
    ],
    "FailedProjectIds": [
      "np_3w****\n"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.