1. 接口描述
接口请求域名: tdid.tencentcloudapi.com 。
更新DID标识的禁用状态
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeactivateTDid。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Did | 否 | String | DID标识符 示例值:did:tdid:w1:0x05cdde231b90dbcb1e0a9e7a616bf17c7168c2ac |
OperateCredential | 否 | String | 设置DID禁用状态的临时凭证内容,通过创建凭证接口(CreateCredential)生成并签名,凭证类型为:OperateCredential, 为安全起见凭证过期时间不适合太长,建议设置为1分钟内 示例值:{\n\t"cptId": 1,\n\t"issuer": "did:tdid:c5:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb",\n\t"expirationDate": "2023-12-01T10:00:00+08:00",\n\t"issuanceDate": "2023-09-19T19:50:52+08:00",\n\t"context": "https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\n\t\"id\": "250d0563e9d680c4d2c33b428913442f",\n\t"type": ["VerifiableCredential"],\n\t"credentialSubject": {\n\t\t"action": "deactiveDid",\n\t\t"deactivated": "true",\n\t\t"did": "did:tdid:c5:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb"\n\t},\n\t"proof": {\n\t\t"created": "2023-09-19T19:50:52+08:00",\n\t\t"creator": "did:tdid:c5:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb#keys-0",\n\t\t"signatureValue": "MEYCIQDSQFpHNt7xltx+dPhwHDrY3kJpMG+hE7Klh/c11Ce3WQIhAOFaISj1kvk8TjrlMaoTAAhoAiriBFj0lLwWyNp69kW7",\n\t\t"type": "Secp256r1",\n\t\t"metaDigest": "9b916ba1e4435f752052fbafe3ed270b61f729feade30fec20aeef4dbac16712",\n\t\t"vcDigest": "692c38a285093f538821f7cce3ddc8358f10f219e991faf226356043228eda24",\n\t\t"privacy": "Public",\n\t\t"salt": {\n\t\t\t"action": "CTtap",\n\t\t\t"deactivated": "1jfRX",\n\t\t\t"did": "D8ukJ"\n\t\t}\n\t}\n} |
DAPId | 否 | Integer | DID应用Id 示例值:1 |
Deactivated | 否 | String | 是否禁用 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Transaction | ChainTransaction | 上链交易信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新DID标识的禁用状态
更新DID标识的禁用状态
输入示例
POST / HTTP/1.1
Host: tdid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeactivateTDid
<公共请求参数>
{
"Did": "did:tdid:w1:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb",
"OperateCredential": "{\n\t\"cptId\": 1,\n\t\"issuer\": \"did:tdid:w1:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb\",\n\t\"expirationDate\": \"2023-12-01T10:00:00+08:00\",\n\t\"issuanceDate\": \"2023-09-19T19:50:52+08:00\",\n\t\"context\": \"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\n\t\"id\": \"250d0563e9d680c4d2c33b428913442f\",\n\t\"type\": [\"VerifiableCredential\"],\n\t\"credentialSubject\": {\n\t\t\"action\": \"deactiveDid\",\n\t\t\"deactivated\": \"true\",\n\t\t\"did\": \"did:tdid:w1:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb\"\n\t},\n\t\"proof\": {\n\t\t\"created\": \"2023-09-19T19:50:52+08:00\",\n\t\t\"creator\": \"did:tdid:c5:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb#keys-0\",\n\t\t\"signatureValue\": \"MEYCIQDSQFpHNt7xltx+dPhwHDrY3kJpMG+hE7Klh/c11Ce3WQIhAOFaISj1kvk8TjrlMaoTAAhoAiriBFj0lLwWyNp69kW7\",\n\t\t\"type\": \"Secp256r1\",\n\t\t\"metaDigest\": \"9b916ba1e4435f752052fbafe3ed270b61f729feade30fec20aeef4dbac16712\",\n\t\t\"vcDigest\": \"692c38a285093f538821f7cce3ddc8358f10f219e991faf226356043228eda24\",\n\t\t\"privacy\": \"Public\",\n\t\t\"salt\": {\n\t\t\t\"action\": \"CTtap\",\n\t\t\t\"deactivated\": \"1jfRX\",\n\t\t\t\"did\": \"D8ukJ\"\n\t\t}\n\t}\n}",
"DAPId": 5
}
输出示例
{
"Response": {
"Transaction": {
"TransactionHash": "17a6bfc02e84d8afca728a0285e5cfc20812a7ca5e0244188a1fdb12cf402789"
},
"RequestId": "018647ac-f5ef-478e-bc7c-1e72ae4afac1"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
Cam.InvalidAuth | CAM鉴权失败 |
Credential.CredentialExpired | 凭证过期:<%ExtMsg%> |
Credential.HolderDidNotMatch | 凭证持有人DID不匹配,请确认后重新操作:<%ExtMsg%> |
Credential.InvalidCRDLId | 无效的凭证ID,请确认后重新操作:<%ExtMsg%> |
Credential.InvalidCRDLIssuer | 无效的凭证颁发者,请确认后重新操作 |
Credential.InvalidClaim | 无效的凭证声明,请确认声明格式:<%ExtMsg%> |
Credential.InvalidOperateClaim | 无效的操作类型声明,请确认后重新操作:<%ExtMsg%> |
Credential.InvalidParas | 无效请求参数,请确认参数格式:<%ExtMsg%> |
Credential.IssuerDidNotMatch | 凭证颁发者DID不匹配,请确认后重新操作:<%ExtMsg%> |
Credential.NoIdInClaim | 凭证声明缺少ID字段,请确认后重新操作 |
Credential.VerifyCRDLFailed | 凭证验证失败:<%ExtMsg%> |
DataBase.FailedOperation | 数据库操作失败,请重新操作 |
Did.PermissionDenied | 您无操作权限 |
DidFailedOperation.DidNotExisted | DID标识不存在:<%ExtMsg%> |
DidFailedOperation.DidStatusInvalid | DID状态无效 |
DidFailedOperation.DidSvcNotExisted | 用户尚未创建DID服务,请确认后重新操作 |
DidFailedOperation.NotDidCreator | 非DID创建者,无法更新DID状态 |
DidSdk.UnknownError | DID服务请求错误,请稍后重试或联系客服 |
FailedOperation.InvalidAuth | 用户接口鉴权失败 |
FailedOperation.OperationException | 操作失败。 |
FailedOperation.PermissionDenied | 用户无接口访问权限 |
HttpInvoker.NewQuestError | HTTP请求创建失败,请稍后重试,或联系客服 |
HttpInvoker.SendQuestError | HTTP请求发送失败,请稍后重试,或联系客服 |
InternalError.ApiUnknownError | API服务出错 |
InternalError.ServiceDisabled | 服务已停止,请您检查当前是否有计费套餐包 |
InternalError.ServiceError | 服务错误,请稍后重试,或联系客服 |
InternalError.UnknownError | 服务错误,请稍后重试,或联系客服 |
InvalidParameterValue.IllegalDateTime | 无效的时间格式,请确认后重新操作 |
InvalidParameterValue.IllegalValue | 请求参数格式错误,请按照格式要求重新填写 |
InvalidParameterValue.ResourceNotExisted | 用户请求资源未存在:<%ExtMsg%> |