DeleteVerifyScheme

更新时间:
复制 MD 格式

If you no longer need a verification scheme, you can call this operation or delete the scheme in the Phone Number Verification Service console.

Operation description

  • After you delete a scheme, authentication requests that use it fail. Delete schemes with care.

  • You cannot modify a verification scheme after you create it. To make changes, delete the original scheme by calling this operation, create a new scheme, and then integrate the new scheme into your application using its parameters.

QPS limits

Each user can make up to 100 API calls per second. If you exceed this limit, API calls are throttled, which may affect your business. Stay within the limit.

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

dypns:DeleteVerifyScheme

delete

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SchemeCode

string

Yes

The scheme code. Get this value from the SchemeCode parameter in the response of the CreateVerifyScheme operation.

FC10000014164****

CustomerId

integer

No

The user ID.

12345678

Response elements

Element

Type

Description

Example

object

Code

string

The status code.

OK

Message

string

The description of the status code.

OK

RequestId

string

The request ID.

E3754956-D0B1-5947-962A-AE767D354F01

Result

boolean

The result of the operation. Valid values:

  • true: The scheme was deleted.

  • false: The scheme failed to be deleted.

true

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "E3754956-D0B1-5947-962A-AE767D354F01",
  "Result": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 Throttling.System The request was denied due to API flow control. Request was denied due to api flow control.
400 InvalidAccountStatus Your account has been suspended.
400 Unsupported.Account Your account has not activated the product. Your account not be opened the product.
400 InvalidParameters The specified parameter is not valid.
500 InternalError An error occurred while processing your request.
500 SystemError An error occurred while processing your request.
403 UnauthorizedOperation You are not authorized to perform this operation. You are not authorized to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.