# 获取与指定资源凭证提供者关联的API密钥
#### 功能介绍
获取与指定资源凭证提供者关联的API密钥。
#### URI
POST /v1/api-key
#### 请求参数
表1请求Body参数 
| 参数                                | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| resource_credential_provider_name | 是    | String | **参数解释**： 要获取API密钥的资源凭证提供者名称。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字及"-"、"_"组成，长度为1\~128个字符。 **默认取值**： 不涉及。 |
| workload_access_token             | 否    | String | **参数解释**： 请求API密钥的工作负载身份令牌。 **约束限制**： 不涉及。 **取值范围**： 长度为1\~131072个字符。 **默认取值**： 不涉及。                     |
   
#### 响应参数
**状态码：200**
表2响应Body参数 
| 参数      | 参数类型   | 描述                                                                                                                                                                 |
|:---|:---|:---|
| api_key | String | **参数解释**： 与请求的资源关联的API密钥。 **取值范围**： 长度为1\~65536个字符。 |
   
**状态码：400**
表3响应Body参数 
| 参数                            | 参数类型   | 描述                                                                                                                                                                   |
|:---|:---|:---|
| error_code                    | String | **参数解释**： 错误码。 **取值范围**： 不涉及。                         |
| error_msg                     | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。                        |
| request_id                    | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。                        |
| encoded_authorization_message | String | **参数解释**： 加密后的认证失败信息，可以通过STS5解密接口进行解密。 **取值范围**： 不涉及。 |
   
**状态码：401**
表4响应Body参数 
| 参数                            | 参数类型   | 描述                                                                                                                                                                   |
|:---|:---|:---|
| error_code                    | String | **参数解释**： 错误码。 **取值范围**： 不涉及。                         |
| error_msg                     | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。                        |
| request_id                    | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。                        |
| encoded_authorization_message | String | **参数解释**： 加密后的认证失败信息，可以通过STS5解密接口进行解密。 **取值范围**： 不涉及。 |
   
**状态码：403**
表5响应Body参数 
| 参数                            | 参数类型   | 描述                                                                                                                                                                   |
|:---|:---|:---|
| error_code                    | String | **参数解释**： 错误码。 **取值范围**： 不涉及。                         |
| error_msg                     | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。                        |
| request_id                    | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。                        |
| encoded_authorization_message | String | **参数解释**： 加密后的认证失败信息，可以通过STS5解密接口进行解密。 **取值范围**： 不涉及。 |
   
**状态码：404**
表6响应Body参数 
| 参数                            | 参数类型   | 描述                                                                                                                                                                   |
|:---|:---|:---|
| error_code                    | String | **参数解释**： 错误码。 **取值范围**： 不涉及。                         |
| error_msg                     | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。                        |
| request_id                    | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。                        |
| encoded_authorization_message | String | **参数解释**： 加密后的认证失败信息，可以通过STS5解密接口进行解密。 **取值范围**： 不涉及。 |
   
**状态码：429**
表7响应Body参数 
| 参数                            | 参数类型   | 描述                                                                                                                                                                   |
|:---|:---|:---|
| error_code                    | String | **参数解释**： 错误码。 **取值范围**： 不涉及。                         |
| error_msg                     | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。                        |
| request_id                    | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。                        |
| encoded_authorization_message | String | **参数解释**： 加密后的认证失败信息，可以通过STS5解密接口进行解密。 **取值范围**： 不涉及。 |
   
**状态码：500**
表8响应Body参数 
| 参数                            | 参数类型   | 描述                                                                                                                                                                   |
|:---|:---|:---|
| error_code                    | String | **参数解释**： 错误码。 **取值范围**： 不涉及。                         |
| error_msg                     | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。                        |
| request_id                    | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。                        |
| encoded_authorization_message | String | **参数解释**： 加密后的认证失败信息，可以通过STS5解密接口进行解密。 **取值范围**： 不涉及。 |
   
#### 请求示例
从资源凭证提供商获取API密钥。
```
POST https://{endpoint}/v1/api-key
{
  "resource_credential_provider_name" : "my-apikey-provider",
  "workload_access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
#### 响应示例
**状态码：200**
```
{
  "api_key" : "sk-example1234567890abcdef"
}
```
#### 状态码
| 状态码 | 描述        |
|:---|:---|
| 200 | 请求成功。     |
| 400 | 请求体异常。    |
| 401 | 认证失败。     |
| 403 | 没有操作权限。   |
| 404 | 未找到相应的资源。 |
| 429 | 请求过于频繁。   |
| 500 | 服务端异常。    |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-agentidentity/ErrorCode.html)。