项目管理

本文介绍了项目管理相关的接口

API 列表

请求方式	API	描述
POST	/v1.0/osaas/project	创建项目
GET	/v1.0/osaas/projects	分页查询项目列表
GET	/v1.0/osaas/projects/{project_id}	获取项目详情
PUT	/v1.0/osaas/projects/{project_id}	修改项目
DELETE	/v1.0/osaas/projects/{project_id}	删除项目

创建项目

接口描述

调用该接口创建项目

接口地址

POST /v1.0/osaas/project

请求参数

参数名	类型	参数类型	说明	是否必需
project_name	String	BODY	项目名称(最大64个字符)	是
location_id	String	BODY	地区唯一标识	是
address	String	BODY	详细地址(最大80个字符)	是
time_zone_id	String	BODY	时区id(Asia/Shanghai)	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	项目唯一标识

请求示例

{
  "address": "详细地址(最大80个字符)",
  "location_id": "地区唯一标识",
  "time_zone_Id": "时区id(Asia/Shanghai)",
  "project_name": "项目名称(最大64个字符)"
}

响应成功示例

{
  "success": true,
  "result": "116082396505314******",
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询项目列表

接口描述

调用该接口分页查询项目列表

接口地址

GET /v1.0/osaas/projects

请求参数

参数名	类型	参数类型	说明	是否必需
page_no	Integer	URL	页码	否
page_size	Integer	URL	页条数(0<page_size<100)	否
project_ids	String[]	URL	项目id列表	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
projects	Arrays	项目集合

projects参数说明

参数名	类型	说明
project_id	String	项目唯一标识
project_name	String	项目名称
location_id	String	基础位置唯一标识
address	String	详细地址
time_zone_id	String	时区id
authorization_status	String	授权状态 UNAUTHORIZED:未授权 AUTHORIZED:已授权
gmt_create	Long	创建时间，13位时间戳
gmt_modified	Long	修改时间，13位时间戳

请求示例

GET {url}/v1.0/osaas/projects?page_no=1&page_size=20

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 20,
    "projects": [
      {
        "project_id": "116082396505314******",
        "project_name": "**项目",
        "location_id": "1002",
        "address": "**省 ** 市",
        "time_zone_id": "Asia/Shanghai",
        "authorization_status": "AUTHORIZED",
         "gmt_create": 1559707046000,
        "gmt_modified": 1559707046000
      }
    ]
    },
    "success": true,
    "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取项目详情

接口描述

调用该接口获取项目详情

接口地址

GET /v1.0/osaas/projects/{project_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
project_id	String	项目id
project_name	String	项目名称
location_id	String	基础位置唯一标识
address	String	详细地址
time_zone_id	String	时区 id
authorization_status	String	授权状态 UNAUTHORIZED:未授权 AUTHORIZED:已授权
gmt_create	Long	创建时间，13 位时间戳
gmt_modified	Long	修改时间，13 位时间戳

请求示例

GET {url}/v1.0/osaas/projects/116082396505312*******

响应成功示例

{
  "success": true,
  "result": {
    "project_id": "116082396505314******",
    "project_name": "**项目",
    "location_id": "1002",
    "address": "**省 ** 市",
    "time_zone_id": "Asia/Shanghai",
    "authorization_status": "AUTHORIZED",
    "gmt_create": 1559707046000,
    "gmt_modified": 1559707046000
  },
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

修改项目

接口描述

调用该接口修改项目

接口地址

PUT /v1.0/osaas/projects/{project_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
project_name	String	BODY	项目名称(最大64个字符)	否
location_id	String	BODY	基础位置唯一标识	否
address	String	BODY	详细地址(最大80个字符)	否
time_zone_id	String	BODY	时区唯一标识(Asia/Shanghai)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

PUT {url}/v1.0/osaas/projects/1160823965053******

{
  "project_name": "***项目",
  "location_id": "11",
  "address": "***路***号",
  "time_zone_id": "Asia/Shanghai"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

删除项目

接口描述

该用该接口删除项目

接口地址

DELETE /v1.0/osaas/projects/{project_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

DELETE {url}/v1.0/osaas/projects/11608239650531***

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误