云服务器内容精选

  • 响应示例 状态码:200 OK { "total_count" : 1, "auth" : [ { "user_id" : "****d80fb058844ae8b82aa66d9fe****", "user_name" : "iam-user01", "type" : "agency", "content" : "modelarts_agency", "create_time" : 15657747821288 } ] }
  • URI GET /v2/{project_id}/authorizations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 sort_by 否 String 指定排序字段。枚举值如下: user_name: IAM 用户名称 create_time:创建时间 order 否 String 排序方式。枚举值如下: asc:递增排序 desc:递减排序 limit 否 Integer 指定每一页返回的最大条目数,默认为1000。 取值范围[1,1000]。 offset 否 Integer 分页列表的起始页,默认为0。
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 total_count Number 授权信息总数。 auth Array of AuthorizationResponse objects 授权信息列表。 表4 AuthorizationResponse 参数 参数类型 描述 user_id String 用户ID,获取方法请参见获取用户ID和名称。 当user_id为all时,表示对所有IAM子用户进行授权,如果已有部分用户已授权,则更新授权。 仅当授权类型为委托时,需要该字段。 type String 授权类型。推荐使用委托方式。 可选值: agency:委托 credential:访问密钥(AK/SK) content String 授权内容。 当授权类型是委托,该字段为委托名称。 当授权类型是访问密钥,该字段为访问密钥ID(AK)。 secret_key String 秘密访问密钥(SK)。仅当授权类型为访问密钥时,需要该字段。 user_name String 用户名,当user_id为all-users时,显示为所有用户。 create_time Long 创建时间戳。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32 表3 请求Body参数 参数 是否必选 参数类型 描述 port 是 Integer 主机端口 最小值:1 最大值:65535 account 是 String 主机账号 最小长度:1 最大长度:64 password 是 String 主机密码 最小长度:1 最大长度:1024 group_id 否 String 组id 最小长度:0 最大长度:64
  • 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次返回的列表长度 auths 字典数据类型 本次返回的API列表 表4 auths参数说明 名称 类型 说明 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组 api_remark String API的描述信息 api_type Integer API类型 envname String API授权绑定的环境名称 env_id String API授权绑定的环境编号 auth_role String 授权者 auth_time String 授权创建的时间 appid String APP的编号 app_name String APP的名称 app_creator String APP的创建者,取值如下: USER:租户自己创建 MARKET:API市场分配 app_remark String APP的描述信息 app_type String APP的类型 publish_id String API的发布编号 响应消息样例: {"total": 1,"size": 1,"auths": [{"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a","api_id": "6632a062-9dcf-4f18-9646-3cabb925a290","api_name": "查询API列表","group_name": "api_group_001","api_type": 1,"api_remark": "查询API列表","envname": "RELEASE","auth_role": "PROVIDER","auth_time": "2017-12-28T12:46:43Z","appid": "14b399ac-967f-4115-bb62-c0346b4537e9","app_name": "app_001","app_creator": "USER","env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID","app_remark": "APP的描述信息","app_type": "apig","publish_id": "f500ba7e369b4b1ebae99aa9d114a17a"}]}
  • URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apis[?page_size, page_no, app_id, api_id, api_name,group_id,group_name,env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:app_id、 api_id 、 api_name、group_id、group_name、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 app_id 是 String 应用编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号 group_name 否 String API分组名称 env_id 否 String 授权的环境编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1
  • 响应示例 状态码: 200 OK { "total" : 2, "size" : 2, "apis" : [ { "auth_type" : "APP", "run_env_name" : "", "group_name" : "api_group_001", "publish_id" : "", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_function", "remark" : "FunctionGraph backend API", "run_env_id" : "", "id" : "abd9c4b2ff974888b0ba79be7e6b2763", "req_uri" : "/test/function" }, { "auth_type" : "APP", "run_env_name" : "RELEASE", "group_name" : "APIGroup_d3da", "publish_id" : "ca2631e233a74a758744ae1e19cc5ad7", "group_id" : "6acd94abe58747ee8a73b10c70817bac", "name" : "API_test", "remark" : "FunctionGraph backend API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "11cbec3a7a8345ca981b86d161bc436e", "req_uri" : "/appcode" } ]} 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_name. Please refer to the support documentation"} 状态码: 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed"} 状态码: 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method"} 状态码: 404 Not Found { "error_code" : "APIG.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"} 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 app_id 是 String 应用id env_id 是 String 环境id group_id 否 String API分组编号 api_id 否 String API编号 api_name 否 String API名称 tags 否 String API标签,该参数可指定多个,多个不同的参数值为或关系;不指定或为空时,表示不筛选标签;指定为#no_tags#时,表示筛选无标签API。 最小长度:0 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiOutline objects 本次返回的API列表 表5 ApiOutline 参数 参数类型 描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境id id String API编号 req_uri String API的请求地址 tags Array of strings API绑定的标签,标签配额默认10条,可以联系技术调整。 最小长度:1 最大长度:128 数组长度:0 - 10 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 角色介绍 角色是SIM Space平台提供的一种根据用户的工作职能定义权限的授权机制。SIM Space平台为您预置了租户管理员和仿真工程师两种角色。当预置角色不能满足您的需求时,可参考新建角色中操作,自定义所需的角色,并通过给角色授予不同的权限来进行精细的访问控制,自定义角色是对预置角色的扩展和补充。 表1 SIM Space默认角色 默认角色 说明 租户管理员 系统默认角色,可进行角色管理、用户登录授权、团队管理、资源管理、作业管理、应用许可配置和仿真应用使用。 仿真工程师 系统默认角色,可进行仿真数据管理、仿真作业管理和仿真应用使用。
  • 请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-groups/actions/batch-delete-authorization{ "app_group_ids" : [ "571784876773081141" ], "accounts" : [ { "account" : "user000", "account_type" : "USER", "domain" : "wksapp***.huawei.com" } ]}
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 X-Language 否 String 语言: zh-cn:中文 en-us:英文 fr-fr: 法文 表3 请求Body参数 参数 是否必选 参数类型 描述 app_group_ids 是 Array of strings 应用组ID,最多同时操作10个。 accounts 是 Array of AccountInfo objects 用户(组),单次最多允许操作50个用户(组)。 表4 AccountInfo 参数 是否必选 参数类型 描述 id 否 String 用户ID(或用户组ID),根据 account_type 参数决定值类型。 对于用户组类型,必须传入用户组ID。 USER - 用户ID。 USER_GROUP - 用户组ID。 account 是 String 用户名(或用户组名),根据 account_type 参数决定值类型。 USER - 用户名。 USER_GROUP - 用户组名。 account_type 是 String 用户类型: USER - 用户 USER_GROUP - 用户组 domain 否 String 域名 城。 email 否 String 邮箱。 telephone_number 否 String 手机。 platform_type 否 String 平台类型: AD - AD域 LOCAL - LiteAs SYSTEM - 系统内置
  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "apis" : [ { "req_uri" : "/test/function", "req_method" : "GET", "match_mode" : "NORMAL", "duplicated_apis" : [ { "api_id" : "e25fcb255a664e80aa40759d37d043e9", "api_name" : "api_demo", "group_id" : "86d75a6b1d6c4cca99e1bed795074167", "group_name" : "DEFAULT", "api_type" : "self-owned" }, { "api_id" : "d41f91f14ecc476fa9bdef54afb37f06", "api_name" : "api_demo_duplicate", "group_id" : "c3053da9dcd54ffba3bf6e0fb7721a82", "group_name" : "EchoDemo", "api_type" : "self-owned" } ] } ]} 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_name. Please refer to the support documentation"} 状态码: 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed"} 状态码: 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method"} 状态码: 404 Not Found { "error_code" : "APIG.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"} 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiDuplicationInfo objects 应用下所有路径冲突的API信息列表 表5 ApiDuplicationInfo 参数 参数类型 描述 req_method String 请求方式 req_uri String API的访问地址 match_mode String API的匹配方式 SWA:前缀匹配 NORMAL:正常匹配(绝对匹配) 默认:NORMAL duplicated_apis Array of DuplicateApiInfo objects 该路径下冲突的API列表 表6 DuplicateApiInfo 参数 参数类型 描述 api_id String API ID api_name String API名称 group_name String 分组名称 group_id String 分组ID remark String API描述 api_type String API类型: self-owned:自有API authorized:授权API 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述