GetCredential - 查询一个凭据信息

更新时间:
复制为 MD 格式

查询一个凭据资源信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CredentialId

string

凭据 ID。

cred_mkv7rgt4d7i4u7zqtzev2mxxxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

Credential

object

凭据信息。

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CredentialId

string

凭据 ID。

cred_mkv7rgt4d7i4u7zqtzev2mxxxx

Status

string

凭据状态。取值可选范围:

  • enabled:启用。

  • disabled:禁用。

enabled

CredentialIdentifier

string

凭据标识。

credential_identifier_test

CredentialName

string

凭据名称。

credential_name

CredentialSubjectType

string

凭据所属的主体类型。取值可选范围:

  • authentication_token_provider:认证令牌提供商。

authentication_token_provider

CredentialSubjectId

string

凭据所属的主体 ID。

apt_werthgfdsasffxxxxx

CredentialScenarioLabel

string

凭据的使用场景标签。取值可选范围:

  • llm:大模型。

  • saas:三方 SaaS 服务。

llm

CredentialType

string

凭据类型。取值可选范围:

  • api_key:API Key 认证凭证。

  • oauth_client:OAuth 客户端认证凭证。

api_key

CredentialCreationType

string

凭据的创建类型。取值可选范围:

  • system_init:系统创建。

  • user_custom:用户创建。

user_custom

Description

string

凭据描述。

credential_description

CreateTime

integer

创建时间,Unix 时间戳格式,单位为毫秒。

1649830225000

UpdateTime

integer

更新时间,Unix 时间戳格式,单位为毫秒。

1649830227000

CredentialContent

object

凭据的内容。

OAuthClientContent

object

OAuth 客户端认证凭证类型的凭据内容。

ClientId

string

OAuth 协议的 client_id。

dmvncmxersdxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Credential": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CredentialId": "cred_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "Status": "enabled",
    "CredentialIdentifier": "credential_identifier_test",
    "CredentialName": "credential_name",
    "CredentialSubjectType": "authentication_token_provider",
    "CredentialSubjectId": "apt_werthgfdsasffxxxxx",
    "CredentialScenarioLabel": "llm",
    "CredentialType": "api_key",
    "CredentialCreationType": "user_custom",
    "Description": "credential_description",
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830227000,
    "CredentialContent": {
      "OAuthClientContent": {
        "ClientId": "dmvncmxersdxxxxxx"
      }
    }
  }
}

错误码

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

变更历史

更多信息,参考变更详情