文档中心 > API类目 > 钉钉API

dingtalk.oapi.org.openencrypt.registekms (注册kms属性)

用于KMS注册元数据信息，比如kms的数据域名等

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
top_kms_meta	TopKMSMeta	必须			请求参数
└ endpoint String 必须 https://xxx.kms.com kms数据域名 └ extension String 可选 {} 默认值："" 扩展字段,json格式 └ requestid String 必须 fefehhjfh889 请求id └ agentid Number 必须 12678 企业内部应用id └ status Number 必须 1 0：禁用，1：启用

响应参数

名称	类型	示例值	描述
result	String	""	一般是空字符串
success	Boolean	true	接口状态码
errcode	Number	500	错误类型
errmsg	String	"internal server error"	错误消息

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/org/openencrypt/registekms");
OapiOrgOpenencryptRegistekmsRequest req = new OapiOrgOpenencryptRegistekmsRequest();
TopKMSMeta obj1 = new TopKMSMeta();
obj1.setEndpoint("https://xxx.kms.com");
obj1.setExtension("{}");
obj1.setRequestid("fefehhjfh889");
obj1.setAgentid(12678L);
obj1.setStatus(1L);
req.setTopKmsMeta(obj1);
OapiOrgOpenencryptRegistekmsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/org/openencrypt/registekms");
OapiOrgOpenencryptRegistekmsRequest req = new OapiOrgOpenencryptRegistekmsRequest();
OapiOrgOpenencryptRegistekmsRequest.TopKMSMetaDomain obj1 = new OapiOrgOpenencryptRegistekmsRequest.TopKMSMetaDomain();
obj1.Endpoint = "https://xxx.kms.com";
obj1.Extension = "{}";
obj1.Requestid = "fefehhjfh889";
obj1.Agentid = 12678L;
obj1.Status = 1L;
req.TopKmsMeta_ = obj1;
OapiOrgOpenencryptRegistekmsResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiOrgOpenencryptRegistekmsRequest;
$top_kms_meta = new TopKMSMeta;
$top_kms_meta->endpoint="https://xxx.kms.com";
$top_kms_meta->extension="{}";
$top_kms_meta->requestid="fefehhjfh889";
$top_kms_meta->agentid="12678";
$top_kms_meta->status="1";
$req->setTopKmsMeta($top_kms_meta);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/org/openencrypt/registekms");

curl -X POST "https://oapi.dingtalk.com/topapi/org/openencrypt/registekms" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=6351d3af-a79b-4bc5-98d9-2f29cb9ca590' \
-d 'top_kms_meta=null'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiOrgOpenencryptRegistekmsRequest("https://oapi.dingtalk.com/topapi/org/openencrypt/registekms")

req.top_kms_meta=""
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.org.openencrypt.registekms");
add_param(pRequest,"top_kms_meta","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.org.openencrypt.registekms', {
	'top_kms_meta':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":"\"\"",
    "success":true,
    "errcode":500,
    "errmsg":"\"internal server error\""
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.org.openencrypt.registekms (注册kms属性)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ