空间API应用示例
准备数据
在调用API之前(分析类型),您需要准备如下数据。
| 数据项 | 名称 | 说明 | 样例 |
|---|---|---|---|
| 云账户信息 | 项目名 | TICS所属的项目名。 | Project Name |
| 项目ID | TICS所属的项目ID。 | 1551c7f6c808414d8e9f3c514a170f2e | |
| 账户名 | 用户所属的企业账户名称。 | Account Name | |
| 用户名 | 使用云服务的用户名,该用户需要拥有TICS的操作权限。 | Username | |
| 密码 | 用户密码。 | password | |
| Endpoint | IAM的Endpoint | 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同。Endpoint您可以参考终端节点Endpoint获取。 | iam_endpoint |
| TICS的Endpoint | tics_endpoint |
获取用户token
调用获取用户TokenAPI获取token。
- 调用其他API前,需要获取token,并设置成环境变量。
curl -H "Content-Type:application/json" https://{iam_endpoint}/v3/auth/tokens -X POST -d ' { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "Username", "password": "password", "domain": { "name": "Account Name" } } } }, "scope": { "project": { "id": "1551c7f6c808414d8e9f3c514a170f2e" } } } } ' -v -k响应Header中“X-Subject-Token”的值即为Token:
X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
- 使用如下命令将token设置为环境变量,方便后续事项。
export Token = MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
获取空间列表
curl -X GET -H 'Content-Type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{tics_endpoint}/v1/1551c7f6c808414d8e9f3c514a170f2e/league-info -k -v 2.查看空间查询结果,成功响应如下:
{
"total" : 1,
"lists" : [ {
"id" : "ef73b252a0ad4b5db21a12c40a413b2f",
"name" : "test",
"partners" : 3,
"league_status" : "NORMAL",
"type" : "OWNER",
"creator_id" : "098593b08f00d2a34f64c004408b64bc",
"creator_name" : "user01",
"create_time" : 1665215103413,
"create_date" : "2022-10-08T07:45:03.413+00:00",
"expire_time" : 0,
"version" : "1.15.1"
} ]
}