DescribeVerifyScheme - 获取认证方案密钥

调用其他API接口时会用到认证方案密钥等参数信息,本接口用于获取认证方案密钥信息。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypns:DescribeVerifySchemeget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SchemeCodestring

方案号。本参数值可以从 CreateVerifyScheme 接口的返回参数SchemeCode获取。

FC10000010643****
CustomerIdlong

用户 ID。

1234****

返回参数

名称类型描述示例值
object
Codestring

状态码。

OK
Messagestring

状态码的描述。

OK
RequestIdstring

请求 ID。

0C5380A7-2032-5F7D-9614-1BF8B54D16CB
SchemeQueryResultDTOobject

结构体。

AppEncryptInfostring

在控制台创建方案号生成的密钥。

ZDMARqPkyQzWVJjB/sB/+fCp5TA4lNsRnY7rEC+HfGsOIOk1Brj8UyXFW2RBYIWqLieCSo8ZypEaEj+h9rLd3FgpXAjGYDfmOperod6jPUUwFHhBObxK+HuKVoi2jOqN7aDOlyPyGcATyq3BDdlf922JmnFLT8Hvnu4qgzzCZk0LXWTb0XVPnm5/fHUGHEA2Q+aTrGkaWcHjmTDqQ7BtvrAIIcJJkCJu4i1aeU++/0EzGWap4mcb2VhKROBs****

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "0C5380A7-2032-5F7D-9614-1BF8B54D16CB",
  "SchemeQueryResultDTO": {
    "AppEncryptInfo": "ZDMARqPkyQzWVJjB/sB/+fCp5TA4lNsRnY7rEC+HfGsOIOk1Brj8UyXFW2RBYIWqLieCSo8ZypEaEj+h9rLd3FgpXAjGYDfmOperod6jPUUwFHhBObxK+HuKVoi2jOqN7aDOlyPyGcATyq3BDdlf922JmnFLT8Hvnu4qgzzCZk0LXWTb0XVPnm5/fHUGHEA2Q+aTrGkaWcHjmTDqQ7BtvrAIIcJJkCJu4i1aeU++/0EzGWap4mcb2VhKROBs****"
  }
}

错误码

HTTP status code错误码错误信息描述
400Throttling.SystemThe request was denied due to API flow control.接口被限流
400InvalidAccountStatusYour account has been suspended.您的账号已被停机。
400Unsupported.AccountYour account has not activated the product.你的账号没有开通本产品。
400SceneQueryFailThe specified scene does not exist.指定场景未查询到数据
403UnauthorizedOperationYou are not authorized to perform this operation.您无权执行此操作。
403UnauthorizedOperationFailed to verify your access permissions.您的权限校验失败。
500InternalErrorAn error occurred while processing your request.内部错误。
500SystemErrorAn error occurred while processing your request.系统错误。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-07OpenAPI 错误码发生变更查看变更详情