云服务器内容精选

  • 响应示例 状态码: 200 请求成功。 { "manage_account_id" : "string", "account_id" : "string", "account_name" : "string", "account_type" : "string", "owner" : "string", "state" : "string", "message" : "string", "parent_organizational_unit_id" : "string", "parent_organizational_unit_name" : "string", "identity_store_user_name" : "string", "blueprint_product_id" : "string", "blueprint_product_version" : "string", "blueprint_status" : "string", "is_blueprint_has_multi_account_resource" : "boolean", "regions" : [ { "region" : "string", "region_status" : "string" } ], "created_at" : "2023-11-15T07:32:12.283Z", "updated_at" : "2023-11-15T07:32:12.283Z" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 landing_zone_version String Landing Zone版本。 manage_account_id String 管理纳管账号ID。 account_id String 纳管账号ID。 account_name String 纳管账号名称。 account_type String 纳管账号类型。 owner String 纳管账号的创建来源,包括CUSTOM和RGC。 state String 纳管账号状态。 message String 错误状态描述信息。 parent_organizational_unit_id String 父注册OU ID。 parent_organizational_unit_name String 父注册OU名称。 identity_store_user_name String Identity Center用户名。 blueprint_product_id String 模板ID。 blueprint_product_version String 模板版本。 blueprint_status String 模板部署状态,包括失败, 完成, 进行中。 is_blueprint_has_multi_account_resource Boolean 模板是否包含多账号资源。 regions Array of regionManagedList objects 区域信息。 created_at String 组织里某个注册OU下的纳管账号被创建的时间。 updated_at String 组织里某个注册OU下的纳管账号最后一次更新的时间。 表3 regionManagedList 参数 参数类型 描述 region String 区 域名 字。 region_status String 区域的状态,取值为可用或者不可用。
  • 响应示例 返回状态码为200:查询站点信息成功,响应体参考GetSitesOut。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100, "sites" : [ { "siteId" : "7dbda77a-2d6f-42b4-ba5a-1f9c6f84c1d5", "siteName" : "site1", "orgId" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" } ] }
  • URI /controller/campus/api/v1/organization/id/sites 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-10000] 0 页码 1 pageSize 否 int32 [1-1000] 10 页长 10 orgId 是 string 0~64个字符。 - 组织ID "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42"
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/organization/id/sites?pageIndex=1&pageSize=10&orgId=b473118d-17ff-4f4f-9fa9-a4c0e1e87e42 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:查询站点信息成功,响应体参考GetSitesOut。 表2 GetSitesOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - 0 错误码。当没有错误时返回0。 "0" errmsg string - 错误信息。当没有错误时返回空。 "" pageIndex int32 - - 页码。 1 pageSize int32 - - 页长。 10 totalRecords int32 - - 组织下站点总数。 100 sites ARRAY_REFERENCE 0-1000个列表项,详细请参见表3。 组织下站点列表。 - 表3 SiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string - - 站点ID。 "7dbda77a-2d6f-42b4-ba5a-1f9c6f84c1d5" siteName string - - 站点名称。 该字段对应UI页面上是:UI【站点名称】 "site1" orgId string - - 组织ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42"
  • 响应示例 返回状态码为200:查询子组织成功,响应体参考GetSubOrgOut。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "subOrgs" : [ { "orgId" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "path" : "/org1/org2", "level" : "2" } ] }
  • 响应参数 返回状态码为200:查询子组织成功,响应体参考GetSubOrgOut。 表2 GetSubOrgOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - 0 错误码。当没有错误时返回0。 "0" errmsg string - 错误信息。当没有错误时返回空。 "" subOrgs ARRAY_REFERENCE 0-1000个列表项,详细请参见表3。 子组织列表。 - 表3 OrgInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 orgId string - - 组织ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" path string - - 组织路径。 "/org1/org2" level int32 - - 组织所在层级。 "2"
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/organization/path/sub-org?path=/org1/org2 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应示例 返回状态码为200:批量创建组织成功,响应体参考CreateOrgOut。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "successList" : [ { "id" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "org1", "parentId" : "f296e87c-ea80-4045-ba00-537054d358a5", "level" : "1" } ], "failList" : [ { "org" : "/org1/org2", "errcode" : "0", "errmsg" : "" } ] }
  • 响应参数 返回状态码为200:批量创建组织成功,响应体参考CreateOrgOut。 表3 CreateOrgOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - 0 错误码。当没有错误时返回0。 "0" errmsg string - 错误信息。当没有错误时返回空。 "" successList ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 创建成功的组织列表。 - failList ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 创建失败的组织列表。 - 表4 SuccessOrgInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 组织ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" name string - - 组织名称。 该字段对应UI页面上是:UI【组织名称】 "org1" parentId string - - 父组织ID。 "f296e87c-ea80-4045-ba00-537054d358a5" level int32 - - 组织所在层级。 "1" 表5 FailOrgInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 org string - - 组织ID/路径。 "/org1/org2" errcode string - - 失败的错误码。 "0" errmsg string - - 失败的错误信息。 ""
  • 请求示例 HTTP的示例 POST /controller/campus/api/v1/organization/path HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "orgs" : ["/org1/org2","/org11/org22"], "cascade" : true }
  • 响应示例 返回状态码为200:查询子组织成功,响应体参考GetSubOrgOut。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "subOrgs" : [ { "orgId" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "path" : "/org1/org2", "level" : "2" } ] }
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/organization/id/sub-org?id=b473118d-17ff-4f4f-9fa9-a4c0e1e87e42 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应示例 返回状态码为200:批量删除组织成功,响应体参考BatchOperOrgOut。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "successList" : ["/org1/org2","/org11/org22"], "failList" : [ { "org" : "/org1/org2", "errcode" : "0", "errmsg" : "" } ] }