有奖捉虫:云通信与企业服务文档专题,速来> HOT

接口描述

  • 接口名称:GetService
  • 接口功能:该接⼝用于查询请求者名下的数据保险箱列表。

请求

请求示例

GET / HTTP/1.1
Host: service.cdcs.myqcloud.com
Date: GMT Date
Authorization: Auth String

说明:

Authorization: Auth String 的详情,请参⻅ 请求签名 ⽂档。

请求参数

此接⼝⽆请求参数。

请求头

此接⼝仅使⽤公共请求头部,详情请参⻅ 公共请求头部 ⽂档。

请求体

此接⼝⽆请求体。

响应

响应头

此接⼝仅返回公共响应头部,详情请参⻅ 公共响应头部 ⽂档。

响应体

查询成功,返回application/json数据,包含所有或特定地域下的保险箱列表。

{
 "Owner": {
        "ID": "string",
        "DisplayName": "string"
    },
    "Coffers": {
        "Coffer": [{
            "Name": "string",
            "Locations": {
                "Location": ["Enum1"]
            },
            "CreationDate": "date",
        }, {
            "Name": "string",
            "Locations": {
                "Location": ["Enum1"]
            },
            "CreationDate": "date",
        }]
    }
}

请求参数描述如下

节点名称(关键字) 类型 描述
Owner Object 保险箱持有者信息。
Coffers Object 保险箱列表。

Owner 对象的描述:

节点名称(关键字) 类型 描述
ID string 保险箱持有者的完整 ID,格式为qcs::cam::uin/[OwnerUin]:uin/[OwnerUin]
例如 qcs::cam::uin/100000000001:uin/100000000001
DisplayName string 保险箱持有者的名字。

Coffer 对象的描述:

节点名称(关键字) 类型 描述
Name string 保险箱的名称,格式为 <CofferName-APPID>
例如 examplecoffer-1250000000
Locations Object 保险箱所在地域列表。
CreationDate date 保险箱的创建时间,为 ISO8601 格式。
例如2019-05-24T105640Z

Locations 对象的描述:

节点名称(关键字) 类型 描述
Location Enum 保险箱所在地域,枚举值请参⻅ 地域和访问域名 ⽂档。
例如 ap-beijing,ap-hongkong,eufrankfurt

错误码

此接口无特殊错误信息,全部错误信息请参⻅ 错误码 ⽂档。

示例

请求

GET / HTTP/1.1
Host: service.cdcs.myqcloud.com
Date: Fri, 24 May 2019 11:59:50 GMT
Authorization: [Auth String]
Connection: close

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 805
Connection: close
Date: Fri, 24 May 2019 11:59:51 GMT
Server: tencent-cdcs
x-cdcs-request-id: NWNlN2RjYjdfOGFiMjM1MGFfNTVjMl8zMmI1****

{
    "Owner": {
        "ID": "1234",
        "DisplayName": "1234"
    },
    "Coffers": {
        "Coffer": [{
            "Name": "xh1592016477536259000-251010571",
            "Locations": {
                "Location": ["ap-tianjin"]
            },
            "CreationDate": "2020-06-13T10:47:58+08:00"
        }, {
            "Name": "xh1592016665413463000-251010571",
            "Locations": {
                "Location": ["ap-tianjin"]
            },
            "CreationDate": "2020-06-13T10:51:05+08:00"
        }, {
            "Name": "xh1592017330996120000-251010571",
            "Locations": {
                "Location": ["ap-tianjin"]
            },
            "CreationDate": "2020-06-13T11:02:11+08:00"
        }, {
            "Name": "xh1592017433508017000-251010571",
            "Locations": {
                "Location": ["ap-tianjin"]
            }
            "CreationDate": "2020-06-13T11:03:54+08:00"
        }]
    }
}