标识注册解析服务接口
1 标识注册接口
1.1 接口描述
从服务端申请一个标识
1.2 请求地址
POST /do/
1.3 请求参数
参数名 | 参数类型 | 是否必须 | 参数描述 |
---|---|---|---|
action | String | 是 | 指定调用的功能,需要设置为forceRegister |
dou | String | 否 | 指定该标识的拥有者,需要为用户的标识 |
repository | String | 否 | 指定该DO所在的数字对象仓库,需要为仓库的标识 |
format | String | 否 | 指定该DO的格式,用户可以自定义 |
pubkey | String | 否 | 标识拥有者的公钥,需要为JWK格式 |
1.4 响应参数
1.4.1 成功返回
参数名 | 参数类型 | 参数描述 |
---|---|---|
identifier | String | 申请到的标识 |
response | String | 服务端返回的成功消息 |
status | String | 服务端返回的状态码,成功时为1 |
1.4.2 失败返回
参数名 | 参数类型 | 参数描述 |
---|---|---|
response | String | 服务端返回的错误消息 |
status | String | 服务端返回的状态码,失败时为0 |
1.5 请求示例
POST http://39.104.122.7:10001/do/
1.5.1 请求头
key | value |
---|---|
Content-Type | application/x-www-form-urlencoded |
1.5.2 请求参数
key | value |
---|---|
action | forceRegister |
dou | 86.5000.470/dou.test |
repository | 86.5000.470/repo.test |
format | Text |
pubkey | MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAgHes68FmNYTgj2UKMu0cAc6+1izOoAkOkcYu+wS3/utvtA98CutdjogZjPVnYP4lumA1TrKo9zY0xGyo/8hkMY3C7Bn9kK3+o1uT0Jv5qPmxc… |
1.5.3 响应内容
{ "identifier": "86.5000.470/do.ojsxe3DqnM", "response": "re-register DO success, identifier: 86.5000.470/do.ojsxe3DqnM", "status": "1" }
2 标识解析接口
2.1 接口描述
从服务端解析指定的标识
2.2 请求地址
GET /resolve
2.3 请求参数
参数名 | 参数类型 | 是否必须 | 参数描述 |
---|---|---|---|
identifier | String | 是 | 要解析的标识 |
2.4 响应参数
2.4.1 成功返回
参数名 | 参数类型 | 参数描述 |
---|---|---|
identifier | String | 要解析的标识 |
owner | String | 标识的拥有者 |
lastModified | String | 上次修改的时间戳 |
… | String | 解析的内容… |
2.4.2 失败返回
参数名 | 参数类型 | 参数描述 |
---|---|---|
identifier | String | 要解析的标识 |
response | String | 服务器返回的错误信息 |
status | String | 服务器返回的状态码 |
2.5 请求示例
GET http://39.104.122.7:10001/resolve?identifier=86.5000.470/doip.NuOtXBtopc
2.5.1 成功响应内容
{ "owner": "86.5000.470/dou.TEST", "identifier": "86.5000.470/doip.NuOtXBtopc", "listeners": "[{\"url\":\"udp://116.62.19.68:18019\",\"protocolVersion\":\"2.1\",\"messageFormat\":\"packet\"}]", "serviceDescription": "test local tcp Repository", "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAgHes68FmNYTgj2UKMu0cAc6+1izOoAkOkcYu+wS3/utvtA98CutdjogZjPVnYP4lumA1TrKo9zY0xGyo/8hkMY3C7Bn9kK3+o1uT0Jv5qPmxcr8E1vZg6joe2k38pHKBkjIctqHDXVrzcoQG1EiUSNQwbhlT/EjNmdzt2+ykmkHf+jiocjwc6TAL0EmifHk4o6kmn4LHvChmTfaMeRUnT2Ol6Aral+dd5RfVhQ1lNsoRfTk7QVR9GETmgLOLDQTbWAkMGg/p6LgQml0eulTTg5SCuoFKY81wruPVeoQ6yfmfX11aKHS88XOEg5qUARGlwncaxMUFqTPpiJwKzzlJrwIDAQAB", "lastModified": "1607506088", "serviceName": "TestTCP" }
2.5.2 失败响应内容
{ "identifier": "86.5000.470/doip.NuOtXBtopc1", "response": "identifier not registered", "status": "0" }
3 删除标识接口
3.1 接口描述
删除已经注册过的标识
3.2 请求地址
POST /do/
3.3 请求参数
参数名 | 参数类型 | 是否必须 | 参数描述 |
---|---|---|---|
action | String | 是 | 选择调用的功能,需要指定为forceDelete |
identifier | String | 是 | 指定要删除的标识 |
3.4 响应参数
3.4.1 成功返回
参数名 | 参数类型 | 参数描述 |
---|---|---|
response | String | 服务器返回的成功消息 |
status | String | 服务器返回的状态码,成功时为1 |
3.4.2 失败返回
参数名 | 参数类型 | 参数描述 |
---|---|---|
response | String | 服务器返回的失败消息 |
status | String | 服务器返回的状态码,失败时为 |
3.5 请求示例
POST http://39.104.122.7:10001/do/
3.5.1 请求头
key | value |
---|---|
Content-Type | application/x-www-form-urlencoded |
3.5.2 请求参数
key | value |
---|---|
action | forceDelete |
identifier | 86.5000.470/do.ojsxe3DqnM |
3.5.3 成功响应内容
{ "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root><type><![CDATA[300]]></type><message><![CDATA[success]]></message></root>", "status": "1" }
3.5.4 失败响应内容
{ "response": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root><type><![CDATA[368]]></type><message><![CDATA[Failed To Delete handle Value:86.5000.470/do.ojsxe3DqnM:HANDLE NOT FOUND\n\t]]></message></root>", "status": "1" }