获取临时密钥和securityToken - ShowCredential
功能介绍
获取临时密钥和securityToken,失效时间大于等于1小时,请在1小时内更新此,接口仅能从租户面调用,无法从管控面调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/instances/{instance_id}/credential
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目编号。获取方法,请参见获取项目ID。 |
| instance_id | 是 | String | LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | Array of strings | 租户token。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| user_names | 否 | Array of strings | IAM用户。 |
| groups | 否 | Array of strings | 用户组。 |
| roles | 否 | Array of strings | 角色。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| access | String | AK。Access Key,是用来标识用户身份的访问密钥。 |
| secret | String | SK。Secret Key,用来对访问密钥进行加密签名,以验证身份。 |
| security_token | String | security_token是将所获的AK、SK等信息进行加密后的字符串。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| solution_msg | String | 解决方案描述。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| solution_msg | String | 解决方案描述。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | Error object | 错误信息。 |
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| title | String | 标题。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| title | String | 标题。 |
| message | String | 错误信息。 |
| code | String | 状态码。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| solution_msg | String | 解决方案描述。 |
状态码:408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| solution_msg | String | 解决方案描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| solution_msg | String | 解决方案描述。 |
请求示例
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/credential
{
"user_names" : [ "user1" ],
"groups" : [ "superGroup" ],
"roles" : [ "admin" ]
} 响应示例
状态码:200
OK
{
"access" : "ABC***123",
"secret" : "ABC***123",
"security_token" : "abc***000"
} 状态码:400
Bad Request
{
"error_code" : "common.01000001",
"error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
} 状态码:401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} 状态码:403
Forbidden
{
"error" : {
"code" : "403",
"message" : "X-Auth-Token is invalid in the request",
"error_code" : null,
"error_msg" : null,
"title" : "Forbidden"
},
"error_code" : "403",
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
} 状态码:404
Not Found
{
"error_code" : "common.01000001",
"error_msg" : "response status exception, code: 404"
} 状态码:408
Request Timeout
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
} 状态码:500
Internal Server Error
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 408 | Request Timeout |
| 500 | Internal Server Error |
错误码
请参见错误码。