ReleaseWorkerInstance-阿里云帮助中心

Use this API to release a transmission instance.

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

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID of the worker instance.	g_abcdefj***

Response elements

Element	Type	Description	Example
	object	The API response.
Success	boolean	Indicates whether the API call succeeded.	true
ErrorDetail	object	Details about the error, if one occurred.
Code	string	The error code.	CM-RESOAT1111
Level	string	The severity level of the error. Valid values: FATAL, ERROR, WARNING, and CRITICAL.	ERROR
Message	string	The error message.	A system error occurred.
ExtraContext	object	Used to populate placeholders in the `Message` field.
	any	Key-value pairs for placeholders in the `Message` string.	null
MessageMcmsKey	string	The localization key for the error message.	null
MessageMcmsContext	object	The context for the localized message.
	string	Key-value pairs for placeholders in the localized message string.	null
Reason	string	The reason for the error.	null
ReasonMcmsKey	string	The localization key for the error reason.	null
ReasonMcmsContext	object	The context for the error reason.
	string	Key-value pairs for placeholders in the localized reason string.	null
Proposal	string	A suggested action to resolve the error.	Contact the administrator.
ProposalMcmsKey	string	The localization key for the proposal.	null
ProposalMcmsContext	object	The context for the proposal.
	string	Key-value pairs for placeholders in the localized proposal string.	null
UpstreamErrorDetail	any	Details of an error from an upstream service, typically for debugging nested HTTP requests.	null
Code	string	The error code, for backward compatibility.	INNER_ERROR
Message	string	The error message, for backward compatibility.	A system error occurred.
Advice	string	The suggested action, for backward compatibility.	Contact the administrator.
RequestId	string	The unique identifier for the request.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	The page number of the returned results. 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 matching entries. Returned only for paginated queries.	100
Cost	string	The time taken to process the request, in seconds.	30
Data	string	The data payload returned by the call.	null

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111",
    "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-XXXX-XXXX-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.