请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetApiKeyCredentialProvider	要执行的操作，取值：GetApiKeyCredentialProvider。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
Name	String	是	test-123	名称
PoolName	String	否	default	工作负载池名称

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ProjectName	String	default	项目名称
Name	String	test-123	名称
CredentialProviderTrn	String	trn:id:${Region}:${Account}:workloadpool/${WorkloadPoolName}/oauth2credentialprovider/${Name}	CredentialProviderTrn field.
ApiKeyMetadata	Array of Object	[{"Location": "example", "ParameterName": "example"}]	API Key元数据
SecretTrn	String	trn:kms:cn-beijing:2100080961:secrets/managed_identity_default.api_key.test	SecretTrn field.
CreatedAt	String	2025-10-30T07:59:24Z	创建时间
UpdatedAt	String	2025-10-30T07:59:24Z	更新时间
PoolName	String	default	工作负载池名称
SecretStorage	Object	{ "StorageType": 1, "EncryptionKey": "trn:kms:cn-beijing:210000:keyrings/keyring_test/keys/key_test" }	加密存储配置

请求示例

POST /?Action=GetApiKeyCredentialProvider&Version=2025-10-30 HTTP/1.1
Host: id.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250930T050139Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250930/cn-beijing/id/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Name": "example"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202510020045430161432262358FFA68",
    "Action": "GetApiKeyCredentialProvider",
    "Version": "2025-10-30",
    "Service": "id",
    "Region": "cn-beijing"
  },
  "Result": {
    "Name": "example",
    "CredentialProviderTrn": "example",
    "ApiKeyMetadata": [],
    "SecretTrn": "example",
    "CreatedAt": "example",
    "UpdatedAt": "example"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.{parameter}	The required parameter %s is missing.	必填参数缺失错误
400	InvalidParameter.{parameter}	The parameter %s is invalid.	参数不合法
400	InvalidRequest	The request is invalid or malformed.	无效请求
400	MissingAction	The request is missing an action.	请求缺少Action
400	InvalidAction	The specified action is invalid.	不合法的Action
401	SignatureNotMatch	The request signature provided is incorrect.	签名缺失或错误
403	AccessDenied	You are not authorized to perform this action.	请求未通过权限验证
403	InvalidAccessKeyId	The access key ID provided is not valid.	不合法的Access Key ld
404	NotFound	Resource not found: %s.	资源不存在
409	Duplicated	Resource already exists: %s.	资源已存在
409	Conflict	Resource conflict.	资源冲突（例如DB的foreign key constraint fails）
429	Throttling	The request is denied due to request throttling.	请求被限流
429	QuotaExceeded	Quota exceeded: %s.	配额已达上限
500	InternalError	Internal server error: %s.	内部服务错误
500	DownstreamServerError	An error has occurred due to an unreachable service.	下游服务请求失败
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	服务不可用

最近更新时间：2026.07.16 14:05:18

这个页面对您有帮助吗？

有用

无用

智能体身份和权限管理平台

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

返回参数

请求示例

返回示例

错误码