Updated on 2026-07-22 GMT+08:00

Obtaining the Asymmetric Signature Switch Status of an Account

Function

This API is used to obtain the asymmetric signature switch status of an account.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

iam::getAsymmetricSignatureSwitchV5

Read

-

-

-

-

URI

GET /v5/asymmetric-signature-switch

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

asymmetric_signature

asymmetric_signature object

Definition:

Asymmetric signature switch of an account.

Range:

N/A

Table 2 asymmetric_signature

Parameter

Type

Description

domain_id

String

Definition:

Account ID.

Range:

N/A

asymmetric_signature_switch

Boolean

Definition:

Asymmetric signature switch.

Range:

The value can be true or false.

Status code: 403

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

encoded_authorization_message

String

Definition :

Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link.

Range:

N/A.

Example Requests

Obtaining the asymmetric signature switch status of an account

GET https://{endpoint}/v5/asymmetric-signature-switch

Example Responses

Status code: 200

Successful

{
  "asymmetric_signature" : {
    "asymmetric_signature_switch" : true,
    "domain_id" : "xxxxx"
  }
}

Status Codes

Status Code

Description

200

Successful

403

Forbidden

Error Codes

See Error Codes.