华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 name String 字典名称。 字符集:中文、英文字母、数字、下划线和空格。 约束:实例下唯一。 code String 字典编码。 字符集:英文字母、数字、下划线和空格。 约束:实例下唯一。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 响应示例 状态码: 200 OK { "id" : "5f918d104dc84480a75166ba99efff21", "tags" : [ "webApi" ], "arrange_necessary" : 2, "backend_type" : "HTTP", "auth_type" : "AUTHORIZER", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac", "backend_api" : { "update_time" : "2020-08-02T16:32:47.077029Z", "vpc_status" : 1, "vpcinfo" : { "vpc_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_proxy_host" : "www.example.com" }, "url_domain" : "56a7d7358e1b42459c9d730d65b14e59", "req_protocol" : "HTTPS", "id" : "1ce8fda3586d4371bd83c955df37e102", "req_method" : "GET", "register_time" : "2020-07-31T12:42:51Z", "req_uri" : "/test/benchmark", "timeout" : 5000, "status" : 1 }, "cors" : false, "status" : 1, "group_name" : "api_group_001", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_version" : "V1", "match_mode" : "NORMAL", "name" : "Api_http", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "type" : 1, "version" : "V0.0.1", "result_normal_sample" : "normal result", "result_failure_sample" : "failure result", "register_time" : "2020-07-31T12:42:51Z", "update_time" : "2020-08-02T16:32:47.046289Z", "remark" : "web api", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo", "id" : "8cb2eba19e7a4423a4e835647a8b8d76" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "consumer app id", "id" : "216ddda836e74d528f364ff589d9dd21" } ] } 状态码: 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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应示例 状态码: 201 OK { "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "name" : "AppName", "remark" : "example", "roles" : [ "read, access, delete, modify, admin" ], "create_time" : "2019-12-06T06:49:04.000Z", "update_time" : "2019-12-06T06:49:04.000Z", "created_user" : { "user_id" : "string", "user_name" : "string" }, "last_updated_user" : { "user_id" : "string", "user_name" : "string" }, "owner" : true, "key" : "TEI9****8UM", "favorite" : true } 状态码: 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 字符集:支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号。 约束:实例下唯一。 remark String 应用描述。 roles Array of strings 应用权限角色。 read:应用下资源只读权限,至少要存在此权限,包括API调试。 access:应用下资源的访问管理权限。 delete:应用下资源的删除权限。 modify:应用下资源的修改权限,包括API发布、下线。 admin:应用和应用下资源的权限。 仅提供admin时,会自动应用其它所有权限。 未提供read时会自动应用read权限。 create_time String 创建时间。 update_time String 更新时间。 created_user created_user object 创建用户信息。 last_updated_user last_updated_user object 最后更新用户信息。 owner Boolean 是否是应用拥有者。 key String 应用认证访问KEY,未提供时随机生成。 字符集:支持中文、英文字母、数字、中划线、下划线、@号和点,以字母或中文或数字开头。 约束:实例下唯一。 favorite Boolean 是否收藏应用,收藏的应用会在列表里优先显示。 表5 created_user 参数 参数类型 描述 user_id String 创建应用的用户ID。 user_name String 创建应用的用户名称。 表6 last_updated_user 参数 参数类型 描述 user_id String 最后修改者的用户ID。 user_name String 最后修改者的用户名。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 应用名称。 字符集:支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号。 约束:实例下唯一。 remark 否 String 应用描述。 key 否 String 应用认证访问KEY,未提供时随机生成。 字符集:支持中文、英文字母、数字、中划线、下划线、@号和点,以字母或中文或数字开头。 约束:实例下唯一。 secret 否 String 应用认证访问SECRET,未提供(字段不存在或值为null)时随机生成。 字符集:英文字母、数字、!、@、#、$、%、+、=、点、中划线、斜线/。 复杂度:满足大小写字母、数字、特殊字符的复杂度组合,考虑兼容性暂时不做复杂度校验。 favorite 否 Boolean 是否收藏应用,收藏的应用会在列表里优先显示。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数,与分页无关。 size Integer 当前页的数量,小于等于请求里指定的limit。 dictionaries Array of Dictionary objects 字典列表。 表5 Dictionary 参数 参数类型 描述 id String 字典ID。 name String 字典名称。 字符集:中文、英文字母、数字、下划线和空格。 约束:实例下唯一。 remark String 字典描述。 code String 字典编码。 字符集:英文字母、数字、下划线和空格。 约束:实例下唯一。 extend_one String 字典扩展字段1。 字符集:中文、英文字母、数字、下划线和空格。 extend_two String 字典扩展字段2。 字符集:中文、英文字母、数字、下划线和空格。 parent_code String 父字典编码,为空时代表自身就是最顶级字典。 type String 字典类型。 system: 代表系统内置字典,用户可编辑但不可删除。 user: 代表用户创建字典。 create_time String 创建时间。 update_time String 更新时间。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 响应示例 状态码: 200 OK { "total" : 0, "size" : 0, "dictionaries" : [ { "id" : "string", "name" : "string", "remark" : "string", "code" : "string", "extend_one" : "string", "extend_two" : "string", "parent_code" : "string", "type" : "system", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z" } ] } 状态码: 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 响应示例 状态码: 200 OK { "variable_value" : "192.168.1.5", "env_id" : "7a1ad0c350844ee69479b47df9a881cb", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "id" : "25054838a624400bbf2267cf5b3a3f70", "variable_name" : "address" } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:variable_name" } 状态码: 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.3003", "error_msg" : "Environment 7a1ad0c350844ee69479b47df9a881cb does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 variable_value String 变量值支持英文字母、数字、英文格式的下划线、中划线,斜线(/)、点、冒号,1 ~ 255个字符。 env_id String 环境编号 最小长度:1 最大长度:65 group_id String API分组编号 最小长度:1 最大长度:65 variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值替换。 说明: 中文字符必须为UTF-8或者unicode编码。 id String 环境变量编号 状态码: 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 错误描述 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 variable_value 是 String 变量值支持英文字母、数字、英文格式的下划线、中划线,斜线(/)、点、冒号,1 ~ 255个字符。
  • 响应示例 状态码: 200 OK { "id" : "string", "name" : "string", "remark" : "string", "code" : "string", "extend_one" : "string", "extend_two" : "string", "parent_code" : "string", "type" : "system", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z" } 状态码: 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 字典名称。 字符集:中文、英文字母、数字、下划线和空格。 约束:实例下唯一。 remark 否 String 字典描述。 order 否 Integer 字典排序,值越小顺序越靠前。 extend_one 否 String 字典扩展字段1。 字符集:中文、英文字母、数字、下划线和空格。 extend_two 否 String 字典扩展字段2。 字符集:中文、英文字母、数字、下划线和空格。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 字典ID。 name String 字典名称。 字符集:中文、英文字母、数字、下划线和空格。 约束:实例下唯一。 remark String 字典描述。 code String 字典编码。 字符集:英文字母、数字、下划线和空格。 约束:实例下唯一。 extend_one String 字典扩展字段1。 字符集:中文、英文字母、数字、下划线和空格。 extend_two String 字典扩展字段2。 字符集:中文、英文字母、数字、下划线和空格。 parent_code String 父字典编码,为空时代表自身就是最顶级字典。 type String 字典类型。 system: 代表系统内置字典,用户可编辑但不可删除。 user: 代表用户创建字典。 create_time String 创建时间。 update_time String 更新时间。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 响应示例 状态码: 200 OK { "variable_value" : "192.168.1.5", "env_id" : "7a1ad0c350844ee69479b47df9a881cb", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "id" : "25054838a624400bbf2267cf5b3a3f70", "variable_name" : "address" } 状态码: 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.3011", "error_msg" : "The environment variable does not exist, id: 25054838a624400bbf2267cf5b3a3f70" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 variable_value String 变量值支持英文字母、数字、英文格式的下划线、中划线,斜线(/)、点、冒号,1 ~ 255个字符。 env_id String 环境编号 最小长度:1 最大长度:65 group_id String API分组编号 最小长度:1 最大长度:65 variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值替换。 说明: 中文字符必须为UTF-8或者unicode编码。 id String 环境变量编号 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "job_id" : "ff8080814dbd65d7014dbe0d84db0013" } 状态码: 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 job_id String 资产导入作业的ID,可用于查询作业进度,获取导入作业进度。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 响应示例 状态码: 200 OK { "name" : "MyApp", "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "remark" : "" } 状态码: 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码: 404 Not Found { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 字符集:支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号。 约束:实例下唯一。 remark String 应用描述。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 响应示例 状态码: 200 ok { "total" : 0, "size" : 0, "apps" : [ { "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "name" : "AppName", "remark" : "example", "roles" : [ "admin" ], "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z", "created_user" : { "user_id" : "string", "user_name" : "string" }, "last_updated_user" : { "user_id" : "string", "user_name" : "string" }, "owner" : true, "key" : "TEI***8UM", "favorite" : true } ] } 状态码: 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总的应用数量。 size Integer 当前页的数量。 apps Array of ServerAppInfo objects 应用信息。 表5 ServerAppInfo 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 字符集:支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号。 约束:实例下唯一。 remark String 应用描述。 roles Array of strings 应用权限角色。 read:应用下资源只读权限,至少要存在此权限,包括API调试。 access:应用下资源的访问管理权限。 delete:应用下资源的删除权限。 modify:应用下资源的修改权限,包括API发布、下线。 admin:应用和应用下资源的权限。 仅提供admin时,会自动应用其它所有权限。 未提供read时会自动应用read权限。 create_time String 创建时间。 update_time String 更新时间。 created_user created_user object 创建用户信息。 last_updated_user last_updated_user object 最后更新用户信息。 owner Boolean 是否是应用拥有者。 key String 应用认证访问KEY,未提供时随机生成。 字符集:支持中文、英文字母、数字、中划线、下划线、@号和点,以字母或中文或数字开头。 约束:实例下唯一。 favorite Boolean 是否收藏应用,收藏的应用会在列表里优先显示。 表6 created_user 参数 参数类型 描述 user_id String 创建应用的用户ID。 user_name String 创建应用的用户名称。 表7 last_updated_user 参数 参数类型 描述 user_id String 最后修改者的用户ID。 user_name String 最后修改者的用户名。 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 请求示例 创建一个数据字典,指定字典名称和字典编码,字典排序为1。 { "name" : "DictName", "remark" : "example", "code" : "13760c1fe8655e61209b75665e9bef43", "order" : "1", "extend_one" : "param1", "extend_two" : "param2", "parent_code" : "" }
  • 响应示例 状态码: 200 OK { "id" : "string", "name" : "string", "remark" : "string", "code" : "string", "extend_one" : "string", "extend_two" : "string", "parent_code" : "string", "type" : "system", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z" } 状态码: 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 字典ID。 name String 字典名称。 字符集:中文、英文字母、数字、下划线和空格。 约束:实例下唯一。 remark String 字典描述。 code String 字典编码。 字符集:英文字母、数字、下划线和空格。 约束:实例下唯一。 extend_one String 字典扩展字段1。 字符集:中文、英文字母、数字、下划线和空格。 extend_two String 字典扩展字段2。 字符集:中文、英文字母、数字、下划线和空格。 parent_code String 父字典编码,为空时代表自身就是最顶级字典。 type String 字典类型。 system: 代表系统内置字典,用户可编辑但不可删除。 user: 代表用户创建字典。 create_time String 创建时间。 update_time String 更新时间。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 字典名称。 字符集:中文、英文字母、数字、下划线和空格。 约束:实例下唯一。 remark 否 String 字典描述。 code 是 String 字典编码。 字符集:英文字母、数字、下划线和空格。 约束:实例下唯一。 order 否 Integer 字典排序,值越小顺序越靠前。 extend_one 否 String 字典扩展字段1。 字符集:中文、英文字母、数字、下划线和空格。 extend_two 否 String 字典扩展字段2。 字符集:中文、英文字母、数字、下划线和空格。 parent_code 否 String 父字典编码,为空时代表自身就是最顶级字典。
  • 请求示例 创建一个MySQL数据源,连接模式为默认。 { "datasource_name" : "fdi_ds_y3k674", "datasource_type" : "MYSQL", "content" : { "host" : "**.**.**.**", "port" : "3306", "database_name" : "testfdi", "user_name" : "fditest", "password" : "******", "mode" : "default" }, "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd", "description" : "testtesttest" } 创建一个FTP数据源,连接模式为active,协议类型为ftp。 { "datasource_name" : "fdi_ds_v2frp", "datasource_type" : "FTP", "content" : { "ftp_connect_mode" : "active", "host" : "**.**.**.**", "port" : "21", "user_name" : "ftpuser", "password" : "******", "ftp_protocol" : "ftp" }, "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd", "description" : "testtesttest" } 创建一个API数据源,API请求方式为GET,认证方式为无认证。 { "datasource_name" : "fdi_ds_api_v2", "datasource_type" : "API", "content" : { "url" : "http%3A%2F%2FVM6_ip%3A1080%2F0928njapi", "api_method" : "GET", "api_auth_detail" : { "auth_method" : "none" } }, "description" : "testAPI", "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd" }
  • 响应示例 状态码: 201 Created { "datasource_id" : "123", "datasource_name" : "fdi_ds_api_v2", "datasource_type" : "API", "content" : { "url" : "http%3A%2F%2FVM6_ip%3A1080%2F0928njapi", "api_method" : "GET", "ApiAuthDetail" : { "auth_method" : "none" } }, "description" : "testAPI", "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd" }
  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "instances" : [ { "id" : "e34610ca-0a37-4f04-8856-4101b08cc5e2", "name" : "roma-test", "description" : " ", "flavor_id" : "00400-30101-0--0", "flavor_type" : "basic", "cpu_arch" : "x86_64", "vpc_id" : "000c3783-a9c0-4ee4-ac44-93bfdfbf3340", "subnet_id" : "8e2ee0d5-0f1d-4067-965f-caf00dd65529", "security_group_id" : "56275464-d5f1-417d-a73b-92ee479e91e2", "publicip_enable" : true, "publicip_id" : "55a6ef1b-498d-42fb-bbc7-d01ba1652bfc", "publicip_address" : "139.9.140.164", "status" : "RUNNING", "error_code" : "string", "error_msg" : "string", "charge_type" : "prePaid", "project_id" : "106506b9a92342df9a5025fc12351cfc", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "available_zone_ids" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "enterprise_project_id" : "0" } ] } 状态码: 400 Bad Request { "error_code" : "ROMA.00013000", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码: 401 Unauthorized { "error_code" : "ROMA.00012000", "error_msg" : "Incorrect token or token resolution failed", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码: 403 Forbidden { "error_code" : "ROMA.00012000", "error_msg" : "No permissions to request this method", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码: 500 Internal Server Error { "error_code" : "ROMA.00011000", "error_msg" : "System error", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 列表总数。 size Integer 本页数量。 instances Array of instances objects 实例列表。 表5 instances 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 description String 实例描述。 flavor_id String 实例规格ID。 flavor_type String 实例规格类型。 - 基础版:basic - 专业版:professional - 企业版:enterprise - 铂金版:platinum cpu_arch String CPU架构类型,取值如下: x86_64: x86架构。 aarch64: arm架构。 vpc_id String 实例指定虚拟私有云ID。 subnet_id String 实例指定虚拟私有云子网ID。 security_group_id String 实例指定安全组ID。 publicip_enable Boolean 是否开启公网访问,开启时publicip_id字段必填。 publicip_id String 实例绑定的弹性公网地址ID。 publicip_address String 实例绑定的弹性公网地址。 status String 实例运行状态。 error_code String 错误码。 error_msg String 错误消息。 charge_type String 实例计费模式。 project_id String 租户项目ID。 create_time String 创建时间。 update_time String 更新时间。 maintain_begin String 运维开始时间。 maintain_end String 运维结束时间。 available_zone_ids Array of strings 创实例使用的可用区列表。 enterprise_project_id String 实例所属企业项目ID。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 应用的总成员数量。 id String 应用ID。 users Array of users objects 用户成员列表。 表5 users 参数 参数类型 描述 id String 用户ID。 name String 用户名称。 roles Array of strings 应用权限角色。 read:应用下资源只读权限,至少要存在此权限,包括API调试。 access:应用下资源的访问管理权限。 delete:应用下资源的删除权限。 modify:应用下资源的修改权限,包括API发布、下线。 admin:应用和应用下资源的权限。 仅提供admin时,会自动应用其它所有权限。 未提供read时会自动应用read权限。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。
共100000条