调用其他API接口时会用到认证方案密钥等参数信息,本接口用于获取认证方案密钥信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dypns:DescribeVerifyScheme | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SchemeCode | string | 是 | 方案号。本参数值可以从 CreateVerifyScheme 接口的返回参数 | FC10000010643**** |
CustomerId | long | 否 | 用户 ID。 | 1234**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Throttling.System | The 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. | 你的账号没有开通本产品。 |
400 | SceneQueryFail | The specified scene does not exist. | 指定场景未查询到数据 |
403 | UnauthorizedOperation | You are not authorized to perform this operation. | 您无权执行此操作。 |
403 | UnauthorizedOperation | Failed to verify your access permissions. | 您的权限校验失败。 |
500 | InternalError | An error occurred while processing your request. | 内部错误。 |
500 | SystemError | An error occurred while processing your request. | 系统错误。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-07 | OpenAPI 错误码发生变更 | 查看变更详情 |