huawei-cloud-api-definitions-ECS 0.1.20250919

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"Link":{"description":"相关快捷链接地址。","properties":{"href":{"description":"对应快捷链接。","type":"string"},"rel":{"description":"快捷链接标记名称。","type":"string"}},"required":["href","rel"]},"SimpleFlavor":{"description":"云服务器规格。","properties":{"id":{"description":"云服务器规格的ID。","example":"c3.15xlarge.2","type":"string","x-admin":"False","x-internal":"False"},"links":{"description":"规格相关快捷链接地址。","items":{"$ref":"#/definitions/Link","description":""},"type":"array"}},"required":["id","links"]},"UpdateServerAddress":{"description":"弹性云服务器的网络属性。","properties":{"addr":{"description":"IP地址。","type":"string"},"version":{"description":"IP地址版本。\n\n- 4:代表IPv4。\n- 6:代表IPv6。","example":4,"format":"int32","type":"integer"}},"required":["addr","version"]},"UpdateServerOption":{"description":"更新云服务器Body体。","properties":{"description":{"description":"对弹性云服务器的任意描述。\n\n不能包含“<”,“>”,且长度范围为[0-85]个字符。","example":"new server test","maxLength":85,"minLength":0,"type":"string"},"hostname":{"description":"修改云服务hostname。\n\n命令规范:长度为 [1-64] 个字符,允许使用点号(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,不能出现(.-)和(-.)。","example":"new-server","maxLength":64,"minLength":1,"type":"string"},"name":{"description":"修改后的云服务器名称。\n\n只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-64]个字符。","maxLength":64,"minLength":1,"type":"string"},"user_data":{"description":"修改云服务器云主机过程中待注入实例自定义数据。支持注入文本、文本文件。\n\n示例:\n\nbase64编码前:\n  Linux服务器:\n    #!/bin/bash\n    echo user_test > /home/user.txt\n  Windows服务器:\n    rem cmd\n    echo 111 > c:\\aaa.txt\n\nbase64编码后:\n  Linux服务器:IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA==\n  Windows服务器:cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0","example":"IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA==","type":"string"}}},"UpdateServerRequestBody":{"description":"This is a auto create Body Object","properties":{"server":{"$ref":"#/definitions/UpdateServerOption","description":"要修改的云服务器信息。"}},"required":["server"]},"UpdateServerResponseBody":{"description":"This is a auto create Response Object","properties":{"server":{"$ref":"#/definitions/UpdateServerResult","description":"云服务器详情信息。"}},"required":["server"]},"UpdateServerResult":{"description":"云服务器详情。","properties":{"OS-DCF:diskConfig":{"description":"扩展属性, diskConfig的类型。\n\n- MANUAL,镜像空间不会扩展。\n- AUTO,系统盘镜像空间会自动扩展为与flavor大小一致。","example":"AUTO","type":"string"},"OS-EXT-SRV-ATTR:hostname":{"description":"弹性云服务器的主机名。","type":"string"},"OS-EXT-SRV-ATTR:user_data":{"description":"创建弹性云服务器时指定的user_data(编码过后的信息)。","example":"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRjcGRkSjckWm5WZHNiR253Z0l0SGlxUjZxbWtLTlJaeU9lZUtKd3dPbG9XSFdUeGFzWjA1STYwdnJYRTdTUTZGbEpFbWlXZ21WNGNmZ1pac1laN1BkMTBLRndyeC8nIHwgY2hwYXNzd2Q6666","type":"string"},"accessIPv4":{"description":"预留属性。","type":"string"},"accessIPv6":{"description":"预留属性。","type":"string"},"addresses":{"additionalProperties":{"items":{"$ref":"#/definitions/UpdateServerAddress"},"type":"array"},"description":"弹性云服务器的网络属性。","type":"object"},"created":{"description":"弹性云服务器创建时间。\n\n时间格式例如:2019-05-22T03:19:19Z","example":"2017-07-15T11:30:52Z","type":"string"},"description":{"description":"弹性云服务器的描述信息。","example":"ecs description","type":"string"},"flavor":{"$ref":"#/definitions/SimpleFlavor","description":"弹性云服务器规格信息。"},"hostId":{"description":"弹性云服务器所在主机的主机ID。","example":"c7145889b2e3202cd295ceddb1742ff8941b827b586861fd0acedf64","type":"string"},"id":{"description":"弹性云服务器ID,格式为UUID。","example":"4f4b3dfa-eb70-47cf-a60a-998a53bd6666","type":"string"},"image":{"description":"镜像ID。","type":"string"},"links":{"description":"云服务器相关标记快捷链接信息。","items":{"$ref":"#/definitions/Link","description":""},"type":"array"},"locked":{"description":"弹性云服务器是否为锁定状态。\n\n- true:锁定\n- false:未锁定","example":false,"type":"boolean"},"metadata":{"additionalProperties":{"description":"","type":"string"},"description":"云服务器元数据。","type":"object","x-huawei-extraAnnotation":""},"name":{"description":"弹性云服务器名称。","example":"ecs-test-server","type":"string"},"progress":{"description":"弹性云服务器进度。","example":0,"format":"int32","type":"integer"},"status":{"description":"弹性云服务器状态。\n\n取值范围:\n\nACTIVE、BUILD、DELETED、ERROR、HARD_REBOOT、MIGRATING、PAUSED、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、SHELVED、SHELVED_OFFLOADED、SOFT_DELETED、SUSPENDED、VERIFY_RESIZE\n\n弹性云服务器状态说明请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html)","example":"ACTIVE","type":"string"},"tags":{"description":"云服务器的标签列表。\n\n微版本2.26后支持,如果不使用微版本查询,响应中无tags字段。\n\n系统近期对标签功能进行了升级,升级后,返回的tag值遵循如下规则:\n\n- key与value使用“=”连接,如“key=value”。\n- 如果value为空字符串,则仅返回key。\n- key与value使用“=”连接,如“key=value”。\n- 如果value为空字符串,则仅返回key。","items":{"description":"","type":"string"},"type":"array"},"tenant_id":{"description":"项目ID。","example":"743b4c0428d94531b9f2add666646666","type":"string"},"updated":{"description":"弹性云服务器更新时间。\n\n时间格式例如:2019-05-22T03:30:52Z","example":"2019-05-22T03:30:52Z","type":"string"},"user_id":{"description":"创建弹性云服务器的用户ID,格式为UUID。","example":"05498fe56b8010d41f7fc01e280b6666","type":"string"}},"required":["OS-EXT-SRV-ATTR:hostname","accessIPv4","accessIPv6","addresses","created","flavor","hostId","id","image","links","metadata","name","progress","status","tags","tenant_id","updated","user_id"]}},"description":null,"group_id":"395cf9dd07ff44ddb50f92797b2a85de","host":"ecs.cn-north-4.myhuaweicloud.com","id":"53341dd3c7ec452e889d58bebafd35e0","info_version":"v2","method":"put","name":"UpdateServer","parameters":{"X-Auth-Token":{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},"server_id":{"description":"云服务器ID。","in":"path","name":"server_id","required":true,"type":"string","x-example":"e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67"}},"paths":{"/v1/{project_id}/cloudservers/{server_id}":{"put":{"consumes":[],"deprecated":false,"description":"修改云服务器信息,目前支持修改云服务器名称及描述和hostname。","operationId":"UpdateServer","parameters":[{"description":"项目ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx","x-order":2},{"$ref":"#/parameters/server_id"},{"$ref":"#/parameters/X-Auth-Token"},{"description":"This is a auto create Body Object","in":"body","name":"UpdateServerRequestBody","required":true,"schema":{"$ref":"#/definitions/UpdateServerRequestBody"}}],"produces":[],"responses":{"200":{"description":"OK","examples":{"application/json":{"server":{"OS-DCF:diskConfig":"MANUAL","accessIPv4":"","accessIPv6":"","addresses":{"01d7aef8-442b-408e-b82f-13afff51e4e4":[{"addr":"192.168.26.22","version":4}]},"created":"2019-04-25T11:52:53Z","flavor":{"id":"s2.large.2","links":[{"href":"https://None/66c860cb130b465fbafcdee43fb09c64/flavors/s2.large.2","rel":"bookmark"}]},"hostId":"57d278e7c53d07cd34fad3ba4fdc9f3d779017d0879726d83b45a22a","id":"24930df0-db4c-4a8b-8914-d0bd558564b0","image":"","links":[{"href":"https://None/v2/66c860cb130b465fbafcdee43fb09c64/servers/24930df0-db4c-4a8b-8914-d0bd558564b0","rel":"self"},{"href":"https://None/66c860cb130b465fbafcdee43fb09c64/servers/24930df0-db4c-4a8b-8914-d0bd558564b0","rel":"bookmark"}],"metadata":{"virtual_env_type":"FusionCompute"},"name":"new-test-hostname0000","progress":0,"status":"ACTIVE","tenant_id":"66c860cb130b465fbafcdee43fb09c64","updated":"2019-04-28T08:15:36Z","user_id":"f88581d53be64716a985c66ca28c75f6"}}},"schema":{"$ref":"#/definitions/UpdateServerResponseBody"}}},"summary":"修改云服务器","tags":["生命周期管理"],"x-apiexplorer-hide":"false","x-constraint":"无","x-first-open-time":"2019-5-30","x-hybridcloud":"false","x-is-registered":"Y","x-name":"修改云服务器","x-open-region-cloud":"hc,hk,ctc","x-order":6,"x-publishpath":"","x-request-examples-1":{"server":{"name":"new-server-test"}},"x-request-examples-description-1":"","x-request-examples-text-1":"{\n\t\"server\": {\n\t\t\"name\": \"new-server-test\"\n\t}\n}","x-request-examples-url-1":"PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}","x-scope":"Commercial","x-source":"SelfDeveloped","x-support-sdk":"Y","x-version":"v1"}}},"product_short":"ECS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"修改云服务器","tags":"生命周期管理","uri":null,"version":"2.0"}