diff --git a/docs/as/openapi/as_v1_en.yaml b/docs/as/openapi/as_v1_en.yaml deleted file mode 100755 index 131b4e826..000000000 --- a/docs/as/openapi/as_v1_en.yaml +++ /dev/null @@ -1,10979 +0,0 @@ -swagger: "2.0" -info: - description: "API Management" - version: "v1" - title: "AS" -host: "as.br-iaas-odin1.huaweicloud.com" -basePath: "/" -tags: - - name: "API Management" - - name: "AS Configurations" - - name: "AS Groups" - - name: "AS Policies(V1)" - - name: "AS Policies(V2)" - - name: "AS Policy Execution Logs" - - name: "Instances" - - name: "Lifecycle Hooks" - - name: "Notifications" - - name: "Quotas" - - name: "Scaling Action Logs" - - name: "Tags" - - name: "AS Group ScheduledTask" -schemes: - - "https" -consumes: - - "application/json;charset=UTF-8" -produces: - - "application/json;charset=UTF-8" -paths: - /: - get: - tags: - - "API Management" - summary: "Querying API Versions" - description: "This interface is used to query all API versions of the AS service." - operationId: "ListApiVersions" - parameters: [] - responses: - "200": - description: "Normal" - examples: - application/json: - versions: - - links: - - rel: "self" - href: "https://as.XXX.mycloud.com/autoscaling-api/v1/" - id: "v1" - min_version: "" - status: "CURRENT" - updated: "2016-06-30T00:00:00Z" - version: "" - - links: - - rel: "self" - href: "https://as.XXX.mycloud.com/autoscaling-api/v2/" - id: "v2" - min_version: "" - status: "SUPPORTED" - updated: "2018-03-30T00:00:00Z" - version: "" - schema: - $ref: "#/definitions/ApiVersions" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-support-sdk: "Y" - x-name: "Querying API Versions" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /{api_version}: - get: - tags: - - "API Management" - summary: "Querying a Specified API Version" - description: "This interface is used to query a specified API version of the AS service." - operationId: "ShowApiVersion" - parameters: - - name: "api_version" - in: "path" - description: "Specifies the ID of the AS API version." - required: true - type: "string" - enum: - - "v1" - - "v2" - x-request: "v1" - responses: - "200": - description: "Normal" - examples: - application/json: - version: - links: - - rel: "self" - href: "https://as.XXX.mycloud.com/autoscaling-api/v1/" - id: "v1" - min_version: "" - status: "CURRENT" - updated: "2016-06-30T00:00:00Z" - version: "" - schema: - $ref: "#/definitions/ApiVersion" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-support-sdk: "Y" - x-name: "Querying a Specified API Version" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/v1" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_configuration: - get: - tags: - - "AS Configurations" - summary: "Querying AS Configurations" - description: "This API is used to query AS configurations based on search criteria. The results are displayed by page.Search criteria can be the AS configuration name, image ID, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS configurations can be queried for a tenant by default." - operationId: "ListScalingConfigs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_configuration_name" - in: "query" - description: |- - Specifies the AS configuration name. - - Supports fuzzy search. - required: false - type: "string" - x-order: 3 - x-example: "test" - - name: "image_id" - in: "query" - description: "Specifies the image ID. It is same as imageRef." - required: false - type: "string" - x-order: 4 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - x-order: 5 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value range is 0 to 100." - required: false - type: "integer" - x-order: 6 - x-example: 5 - responses: - "200": - description: "Normal" - examples: - application/json: - total_number: 2 - start_number: 0 - limit: 10 - scaling_configurations: - - tenant: "06057680f980d5762f0cc01cc6a3a509" - scaling_configuration_id: "8249ba60-321c-4a02-a0ca-c38fdd54ab0f" - scaling_configuration_name: "as-config-9818" - instance_config: - flavorRef: "s2.medium.2" - imageRef: "4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "KeyPair-4671-test" - key_fingerprint: "SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs" - adminPass: "***" - metadata: {} - security_groups: - - id: "c7033a8e-77bd-41db-a6f4-5788c0bb7fa9" - multi_flavor_priority_policy: "PICK_FIRST" - scaling_group_id: "5294b80e-ee63-4116-bb71-4ea4cadba995" - create_time: "2021-04-17T07:44:24Z" - - tenant: "06057680f980d5762f0cc01cc6a3a509" - scaling_configuration_id: "ad8ff7b8-eac8-4b91-8ca6-b0fa5391aceb" - scaling_configuration_name: "as-config-01" - instance_config: - flavorRef: "s2.medium.2,s2.medium.4,s6.small.1" - imageRef: "4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "KeyPair-4671-test" - key_fingerprint: "SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs" - adminPass: "***" - metadata: {} - security_groups: - - id: "c7033a8e-77bd-41db-a6f4-5788c0bb7fa9" - multi_flavor_priority_policy: "PICK_FIRST" - scaling_group_id: "4201a1cd-461c-447e-aa7a-a85aeabea5a3" - create_time: "2021-04-10T03:25:24Z" - schema: - $ref: "#/definitions/ScalingConfigListResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the AS configurations with image ID 37ca2b35-6fc7-47ab-93c7-900324809c5c." - x-support-sdk: "Y" - x-name: "Querying AS Configurations" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration?image_id=37ca2b35-6fc7-47ab-93c7-900324809c5c" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - post: - tags: - - "AS Configurations" - summary: "Creating an AS Configuration" - description: "This API is used to create an AS configuration.An AS configuration is a template specifying specifications for the instances to be added to an AS group.The AS configuration is decoupled from the AS group. An AS configuration can be used by multiple AS groups.Up to 100 AS configurations can be created for each user." - operationId: "CreateScalingConfig" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingConfigOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_configuration_id: "f8327883-6a07-4497-9a61-68c03e8e72a2" - schema: - $ref: "#/definitions/ScalingConfigId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-request-examples-description-1: "This example shows how to create an AS configuration with name as-config-tlzp, image ID 627a1223-2ca3-46a7-8d5f-7aef22c74ee6, flavor ID s3.xlarge.4, 40 GB SATA system disk, and SSH key name 100vm_key." - x-support-sdk: "Y" - x-name: "Creating an AS Configuration" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration" - x-request-examples-1: - scaling_configuration_name: "as-config-tlzq" - instance_config: - flavorRef: "s3.xlarge.4" - imageRef: "627a1223-2ca3-46a7-8d5f-7aef22c74ee6" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "100vm_key" - security_groups: - - id: "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" - x-request-examples-text-1: - scaling_configuration_name: "as-config-tlzq" - instance_config: - flavorRef: "s3.xlarge.4" - imageRef: "627a1223-2ca3-46a7-8d5f-7aef22c74ee6" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "100vm_key" - security_groups: - - id: "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}: - get: - tags: - - "AS Configurations" - summary: "Querying AS Configuration Details" - description: "This interface is used to query details about an AS configuration by configuration ID." - operationId: "ShowScalingConfig" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_configuration_id" - in: "path" - description: "Specifies an AS configuration ID, which is unique globally." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_configurations: - tenant: "ce061903a53545dcaddb300093b477d2" - scaling_configuration_id: "6afe46f9-7d3d-4046-8748-3b2a1085ad86" - scaling_configuration_name: "config-name-1" - instance_config: - flavorRef: "s2.medium.2" - imageRef: "4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "KeyPair-4671-test" - key_fingerprint: "SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs" - adminPass: "***" - metadata: {} - security_groups: - - id: "c7033a8e-77bd-41db-a6f4-5788c0bb7fa9" - multi_flavor_priority_policy: "PICK_FIRST" - create_time: "2018-07-23T01:04:07Z" - scaling_group_id: "4201a1cd-461c-447e-aa7a-a85aeabea5a3" - schema: - $ref: "#/definitions/QueryScalingConfigResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-text-1: "This example shows how to query details about the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86." - x-request-examples-1: "This example shows how to query details about the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86." - x-support-sdk: "Y" - x-name: "Querying AS Configuration Details" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Configurations" - description: "Modifying AS Configurations" - summary: "Modifying AS Configurations" - operationId: "UpdateScalingConfig" - parameters: - - name: "project_id" - in: "path" - required: true - type: "string" - - name: "scaling_configuration_id" - in: "path" - required: true - type: "string" - - name: "X-Auth-Token" - in: "header" - required: false - type: "string" - - in: "body" - name: "bodyparam" - required: true - schema: - $ref: "#/definitions/UpdateScalingConfigOption" - responses: - "204": - description: "Request succeeded" - x-api-type: "open-api" - x-support-sdk: "Y" - x-apiexplorer-hide: false - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/8552e3ad-f1b7-4fb1-a8ee-7f715deef8f0" - x-request-examples-description-1: "In this example, the image ID of the AS configuration 8552e3ad-f1b7-4fb1-a8ee-7f715deef8f0 is changed to 3aa499ee-a1f5-4496-8fa8-746be73a9656." - x-request-examples-text-1: - instance_config: - imageRef: "3aa499ee-a1f5-4496-8fa8-746be73a9656" - x-request-examples-1: - instance_config: - imageRef: "3aa499ee-a1f5-4496-8fa8-746be73a9656" - delete: - tags: - - "AS Configurations" - summary: "Deleting an AS Configuration" - description: "This interface is used to delete a specified AS configuration." - operationId: "DeleteScalingConfig" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_configuration_id" - in: "path" - description: "Specifies the AS configuration ID" - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86." - x-support-sdk: "Y" - x-name: "Deleting an AS Configuration" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 4 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_configurations: - post: - tags: - - "AS Configurations" - summary: "Batch Deleting AS Configurations" - description: |- - This interface is used to batch delete AS configurations. - - AS configurations used by AS groups cannot be deleted. - A maximum of 50 AS configurations can be deleted at a time. - operationId: "BatchDeleteScalingConfigs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchDeleteScalingConfigOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS configurations with IDs config1 and config2 in a batch." - x-support-sdk: "Y" - x-name: "Batch Deleting AS Configurations" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_configurations" - x-request-examples-1: - scaling_configuration_id: - - "config1" - - "config2" - x-request-examples-text-1: - scaling_configuration_id: - - "config1" - - "config2" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_group: - get: - tags: - - "AS Groups" - summary: "Querying AS Groups" - description: "This API is used to query AS groups based on search criteria. The results are displayed by page.Search criteria can be the AS group name, AS configuration ID, AS group status, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS groups can be queried for a tenant by default." - operationId: "ListScalingGroups" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_name" - in: "query" - description: |- - Specifies the AS group name. - - Supports fuzzy search. - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 3 - x-example: "test" - - name: "scaling_configuration_id" - in: "query" - description: "Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS Configurations.(https://support.huaweicloud.com/intl/en-us/api-as/as_06_0202.html)" - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 4 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_group_status" - in: "query" - description: |- - Specifies the AS group status. The options are as follows: - - INSERVICE: indicates that the AS group is functional. - PAUSED: indicates that the AS group is paused. - ERROR: indicates that the AS group malfunctions. - DELETING: indicates that the AS group is being deleted. - required: false - type: "string" - enum: - - "INSERVICE" - - "PAUSED" - - "ERROR" - - "DELETING" - x-order: 5 - x-example: "INSERVICE" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum value is 0, and there is no limit on the maximum value." - required: false - type: "integer" - x-order: 6 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - x-order: 7 - x-example: 5 - - name: "enterprise_project_id" - in: "query" - description: "Specifies the enterprise project ID. If all_granted_eps is specified, AS groups in all enterprise projects you have permissions to are listed. For how to obtain an enterprise project ID, see Listing Enterprise Projects(https://support.huaweicloud.com/intl/en-us/api-em/en-us_topic_0121230880.html).NOTE:A Huawei Cloud account and its IAM users assigned with global permissions can view all the AS groups in the account.If an IAM user is assigned with permissions to more 100 enterprise projects, the user can only view the AS groups in the first 100 enterprise projects." - required: false - type: "string" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_groups: - - scaling_group_name: "as-group-dd48" - scaling_group_id: "7d03f471-779e-46b7-a4cd-9601e639e08a" - scaling_group_status: "INSERVICE" - scaling_configuration_id: "57da4923-6067-4952-bedd-f70744332be8" - scaling_configuration_name: "as-config-3565" - current_instance_number: 0 - desire_instance_number: 0 - min_instance_number: 0 - max_instance_number: 1 - cool_down_time: 300 - lbaas_listeners: [] - networks: - - id: "c1a2fdf3-7d65-46bd-a967-039cdea0abd2" - ipv6_enable: false - allowed_address_pairs: [] - available_zones: - - "XXXA" - - "XXXB" - security_groups: [] - create_time: "2021-04-14T03:09:18Z" - vpc_id: "0f9c6ff3-84b9-4f65-be8a-00d6f22572d1" - health_periodic_audit_method: "NOVA_AUDIT" - health_periodic_audit_time: 5 - health_periodic_audit_grace_period: 600 - instance_terminate_policy: "OLD_CONFIG_OLD_INSTANCE" - is_scaling: false - delete_publicip: true - delete_volume: true - enterprise_project_id: "0" - multi_az_priority_policy: "EQUILIBRIUM_DISTRIBUTE" - tags: null - total_number: 1 - start_number: 0 - limit: 10 - schema: - $ref: "#/definitions/ScalingGroupsResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query AS groups with name as-group-test and AS configuration ID 1d281494-6085-4579-b817-c1f813be835f." - x-support-sdk: "Y" - x-name: "Querying AS Groups" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 78 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - post: - tags: - - "AS Groups" - summary: "Creating an AS Group" - description: "An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions. An AS group specifies parameters, such as the maximum number of instances, expected number of instances, minimum number of instances, VPC, subnet, and load balancing.Each user can create a maximum of 10 AS groups by default.If ELB is configured, AS automatically binds or unbinds a load balancer to or from an instance when the instance is added or removed from the AS group.If an AS group uses ELB health check, the listening ports on the load balancers must be enabled for the instances in the AS group. Enable the listening ports in security groups." - operationId: "CreateScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingGroupOption" - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingGroupId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "The following example shows how to create an AS group:The AS group is named GroupNameTest.The AS configuration ID is 47683a91-93ee-462a-a7d7-484c006f4440.The VPC ID is a8327883-6b07-4497-9c61-68d03ee193a, and the network ID is 3cd35bca-5a10-416f-8994-f79169559870.The maximum number of instances is 10, the expected number of instances is 0, and the minimum number of instances is 0.The health check method is ECS health check.When adjusting the number of instances, select target AZ based on the PICK FIRST policy." - x-support-sdk: "Y" - x-name: "Creating an AS Group" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group" - x-request-examples-1: - scaling_group_name: "GroupNameTest" - scaling_configuration_id: "47683a91-93ee-462a-a7d7-484c006f4440" - desire_instance_number: 0 - min_instance_number: 0 - max_instance_number: 10 - health_periodic_audit_method: "NOVA_AUDIT" - vpc_id: "a8327883-6b07-4497-9c61-68d03ee193a" - available_zones: - - "XXXa" - - "XXXb" - networks: - - id: "3cd35bca-5a10-416f-8994-f79169559870" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - multi_az_priority_policy: "PICK_FIRST" - x-request-examples-text-1: - scaling_group_name: "GroupNameTest" - scaling_configuration_id: "47683a91-93ee-462a-a7d7-484c006f4440" - desire_instance_number: 0 - min_instance_number: 0 - max_instance_number: 10 - health_periodic_audit_method: "NOVA_AUDIT" - vpc_id: "a8327883-6b07-4497-9c61-68d03ee193a" - available_zones: - - "XXXa" - - "XXXb" - networks: - - id: "3cd35bca-5a10-416f-8994-f79169559870" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - multi_az_priority_policy: "PICK_FIRST" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 26 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 260 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}: - get: - tags: - - "AS Groups" - summary: "Querying AS Group Details" - description: "This API is used to query details about a specified AS group by group ID." - operationId: "ShowScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_group: - networks: - - id: "a8327883-6b07-4497-9c61-68d03ee193a" - ipv6_enable: true - ipv6_bandwidth: - id: "076ee2ff-f23e-4338-b8ac-1bc7278532d5" - allowed_address_pairs: [] - avaiable_zones: - - "XXXA" - - "XXXB" - scaling_group_name: "as-group-test" - scaling_group_id: "77a7a397-7d2f-4e79-9da9-6a35e2709150" - scaling_group_status: "INSERVICE" - scaling_configuration_id: "1d281494-6085-4579-b817-c1f813be835f" - scaling_configuration_name: "as-config-test" - current_instance_number: 0 - desire_instance_number: 1 - min_instance_number: 0 - max_instance_number: 500 - cool_down_time: 300 - security_groups: - - id: "8a4b1d5b-0054-419f-84b1-5c8a59ebc829" - create_time: "2018-07-23T02:46:29Z" - vpc_id: "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2" - health_periodic_audit_method: "ELB_AUDIT" - health_periodic_audit_time: 5 - health_periodic_audit_grace_period: 600 - instance_terminate_policy: "OLD_CONFIG_OLD_INSTANCE" - is_scaling: false - delete_publicip: false - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - multi_az_priority_policy: "PICK_FIRST" - tags: null - schema: - $ref: "#/definitions/ScalingGroupResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the AS group with ID d4e50321-3777-4135-97f8-9f5e9714a4b0." - x-support-sdk: "Y" - x-name: "Querying AS Group Details" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/d4e50321-3777-4135-97f8-9f5e9714a4b0" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Groups" - summary: "Modifying an AS Group" - description: "This API is used to modify a specified AS group.When the AS configuration of an AS group is changed, the existing instances created using the original AS configuration are not affected.If no scaling action is being performed, you can modify its subnet, ELB, and AZ configurations.Changing the number of expected instances in an AS group will trigger a scaling action to add or remove instances to or from the AS group. The number of expected instances must be greater than or equal to the minimum number of instances and less than or equal to the maximum number of instances." - operationId: "UpdateScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScalingGroupOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_group_id: "a8327883-6b07-4497-9c61-68d03ee193a1" - schema: - $ref: "#/definitions/ScalingGroupId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to change the name, AS configuration, enterprise project, expected number of instances, minimum number of instances, maximum number of instances, and cooldown period of the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1." - x-support-sdk: "Y" - x-name: "Modifying an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 4 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1" - x-request-examples-1: - scaling_group_name: "group_1" - scaling_configuration_id: "f8327883-6a07-4497-9a61-68c03e8e72a2" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - desire_instance_number: 1 - min_instance_number: 1 - max_instance_number: 3 - cool_down_time: 200 - multi_az_priority_policy: "PICK_FIRST" - x-request-examples-text-1: - scaling_group_name: "group_1" - scaling_configuration_id: "f8327883-6a07-4497-9a61-68c03e8e72a2" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - desire_instance_number: 1 - min_instance_number: 1 - max_instance_number: 3 - cool_down_time: 200 - multi_az_priority_policy: "PICK_FIRST" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "AS Groups" - summary: "Deleting an AS Group" - description: "This interface is used to delete a specified AS group.force_delete specifies whether to forcibly delete an AS group, remove the ECS instances and release them when the AS group is running instances or performing scaling actions. By default, its value is no, which means not to forcibly delete the AS group.If the value of force_delete is set to no, the AS group can be deleted only when both the following conditions are met:The AS group is performing no scaling action.The number of running ECS instances (current_instance_number) is 0.If the value of force_delete is set to yes, the AS group enters the DELETING state, rejecting new requests for scaling actions while completing the existing scaling actions. Then, all ECS instances are removed from the AS group and the AS group is deleted. Note that the manually added ECS instances will be removed from the AS group and the ECS instances automatically created by AS will be automatically deleted." - operationId: "DeleteScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "force_delete" - in: "query" - description: |- - Specifies whether to forcibly delete an AS group. Options: - - no (default): indicates that the AS group is not forcibly deleted. - yes: indicates to forcibly delete an AS group. - required: false - type: "string" - enum: - - "yes" - - "no" - x-order: 4 - x-example: "yes" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to forcibly delete the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1." - x-support-sdk: "Y" - x-name: "Deleting an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1?force_delete=yes" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action: - post: - tags: - - "AS Groups" - summary: "Enabling an AS Group" - description: "This interface is used to enable or disable a specified AS group.NOTE:For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an in-progress scaling action, the scaling action does not stop immediately after the AS group is disabled." - operationId: "ResumeScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyParam" - description: "BodyParamters" - required: true - schema: - $ref: "#/definitions/ResumeScalingGroupOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to enable the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1." - x-support-sdk: "Y" - x-name: "Enabling an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 6 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action" - x-request-examples-1: - action: "resume" - x-request-examples-text-1: - action: "resume" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action": - post: - tags: - - "AS Groups" - summary: "Disabling an AS Group" - description: "This interface is used to enable or disable a specified AS group.NOTE:For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an in-progress scaling action, the scaling action does not stop immediately after the AS group is disabled." - operationId: "PauseScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyParam" - description: "BodyParamters" - required: true - schema: - $ref: "#/definitions/PauseScalingGroupOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Disabling an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 6 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action{ \"action\": \"pause\"}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action{ \"action\": \"pause\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - - - - - /autoscaling-api/v1/{project_id}/scaling_policy: - post: - tags: - - "AS Policies(V1)" - summary: "Creating an AS Policy" - description: "This API is used to create an AS policy.An AS policy defines whether to increase or decrease the number of instances in an AS group. If the number and the expected number of instances in an AS group are different due to the execution of the AS policy, AS automatically adjusts the number of instances to the expected.AS supports the following policies: alarm-triggered policy, periodic policy, and scheduled policy.In the execution of the AS policy, you can set the number of instances to be scaled or perform a scaling action according to a percentage specified in the AS policy." - operationId: "CreateScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingPolicyOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create a periodic AS policy named as-policy-7a75. The policy takes effect from 2015-12-14T03:34Z through 2015-12-27T03:34Z. During this period, one instance will be added to AS group with ID 5bc3aa02-b83e-454c-aba1-4d2095c68f8b at 16:00 every day." - x-support-sdk: "Y" - x-name: "Creating an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy" - x-request-examples-1: - scaling_policy_name: "as-policy-7a75" - scaling_policy_action: - operation: "ADD" - instance_number: 1 - cool_down_time: 900 - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - scaling_policy_type: "RECURRENCE" - scaling_group_id: "5bc3aa02-b83e-454c-aba1-4d2095c68f8b" - x-request-examples-text-1: - scaling_policy_name: "as-policy-7a75" - scaling_policy_action: - operation: "ADD" - instance_number: 1 - cool_down_time: 900 - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - scaling_policy_type: "RECURRENCE" - scaling_group_id: "5bc3aa02-b83e-454c-aba1-4d2095c68f8b" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}: - get: - tags: - - "AS Policies(V1)" - summary: "Querying an AS Policy" - description: "This API is used to query details about a specified AS policy by policy ID." - operationId: "ShowScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "" - examples: - application/json: - scaling_policy: - scaling_policy_id: "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - scaling_policy_name: "schedule1" - scaling_policy_type: "SCHEDULED" - scheduled_policy: - launch_time: "2015-07-24T01:21Z" - cool_down_time: 300 - scaling_policy_action: - operation: "REMOVE" - instance_number: 1 - policy_status: "INSERVICE" - create_time: "2015-07-24T01:09:30Z" - schema: - $ref: "#/definitions/ScalingV1Policy" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the AS policy with ID fd7d63ce-8f5c-443e-b9a0-bef9386b23b3." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 8 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Policies(V1)" - summary: "Modifying an AS Policy" - description: "Modifying an AS Policy" - operationId: "UpdateScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies an AS policy ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScalingPolicyOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to modify the periodic AS policy with ID 0h327883-324n-4dzd-9c61-68d03ee191dd for an AS group with two instances. The modification is as follows: The AS policy name is changed to policy_01, and the modification is executed at 16:00 every day from 2016-01-08T17:31Z through 2016-02-08T17:31Z." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Modifying an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd" - x-request-examples-1: - scaling_policy_type: "RECURRENCE" - scaling_policy_name: "policy_01" - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - end_time: "2016-02-08T17:31Z" - start_time: "2016-01-08T17:31Z" - scaling_policy_action: - operation: "SET" - instance_number: 2 - x-request-examples-text-1: - scaling_policy_type: "RECURRENCE" - scaling_policy_name: "policy_01" - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - end_time: "2016-02-08T17:31Z" - start_time: "2016-01-08T17:31Z" - scaling_policy_action: - operation: "SET" - instance_number: 2 - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "AS Policies(V1)" - summary: "Deleting an AS Policy" - description: "This interface is used to delete a specified AS policy." - operationId: "DeleteScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 11 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list: - get: - tags: - - "AS Policies(V1)" - summary: "Querying AS Policies" - description: "This API is used to query AS policies based on search criteria. The results are displayed by page.Search criteria can be the AS policy name, policy type, policy ID, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS policies for a specified AS group can be queried for a tenant by default." - operationId: "ListScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_policy_name" - in: "query" - description: "Specifies the AS policy name." - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 4 - x-example: "test" - - name: "scaling_policy_type" - in: "query" - description: |- - Specifies the AS policy type. - - ALARM: alarm policy - SCHEDULED: scheduled policy - RECURRENCE: periodic policy - required: false - type: "string" - maxLength: 64 - minLength: 1 - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - x-order: 5 - x-example: "ALARM" - - name: "scaling_policy_id" - in: "query" - description: "Specifies the AS policy ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 6 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - format: "int32" - x-order: 7 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - maximum: 100 - minimum: 0 - x-order: 8 - x-example: 5 - responses: - "200": - description: "Normal" - examples: - application/json: - limit: 20 - total_number: 1 - start_number: 0 - scaling_policies: - - scaling_policy_id: "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - scaling_policy_name: "as-policy-test" - scaling_policy_type: "SCHEDULED" - scheduled_policy: - launch_time: "2015-07-24T01:21Z" - cool_down_time: 300 - scaling_policy_action: - operation: "REMOVE" - instance_number: 1 - policy_status: "INSERVICE" - create_time: "2015-07-24T01:09:30Z" - schema: - $ref: "#/definitions/ScalingV1Policies" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query scheduled AS policies named as-policy-test in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?scaling_policy_name=as-policy-test&scaling_policy_type=SCHEDULED" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policies/action: - post: - tags: - - "AS Policies(V1)" - summary: "Batch Managing AS Policies" - description: "This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time." - operationId: "BatchDeleteScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchDeleteScalingPoliciesOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS policies with IDs policy_id1 and policy_id2 in a batch." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Batch Managing AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 12 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action" - x-request-examples-1: - action: "delete" - scaling_policy_id: - - "policy_id1" - - "policy_id2" - x-request-examples-text-1: - action: "delete" - scaling_policy_id: - - "policy_id1" - - "policy_id2" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_policies/action": - post: - tags: - - "AS Policies(V1)" - summary: "Batch Managing AS Policies" - description: "This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time." - operationId: "BatchPauseScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchPauseScalingPoliciesOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Batch Managing AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 12 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"pause\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"pause\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "02 /autoscaling-api/v1/{project_id}/scaling_policies/action": - post: - tags: - - "AS Policies(V1)" - summary: "Batch Managing AS Policies" - description: "This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time." - operationId: "BatchResumeScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchResumeScalingPoliciesOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Batch Managing AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 12 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"resume\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"resume\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action: - post: - tags: - - "AS Policies(V1)" - summary: "Executing an AS Policy" - description: "This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails." - operationId: "ExecuteScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/ExecuteScalingPolicyOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to immediately execute the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Executing an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 10 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action" - x-request-examples-1: - action: "execute" - x-request-examples-text-1: - action: "execute" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action": - post: - tags: - - "AS Policies(V1)" - summary: "Enabling an AS Policy" - description: "This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails." - operationId: "ResumeScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/ResumeScalingPolicyOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Enabling an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 10 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"resume\"}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"resume\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "02 /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action": - post: - tags: - - "AS Policies(V1)" - summary: "Disabling an AS Policy" - description: "This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails." - operationId: "PauseScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/PauseScalingPolicyOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Disabling an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 10 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"pause\"}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"pause\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v2/{project_id}/scaling_policy: - get: - tags: - - "AS Policies(V2)" - summary: "Querying AS Policies (V2)" - description: "This API is used to query all AS policies for a tenant based on search criteria. The results are displayed by page.Search criteria can be the AS resource ID, AS resource type, AS policy name, AS policy ID, alarm ID, enterprise project ID, start line number, number of records, and sorting method.If no search criteria are specified, a maximum of 20 AS policies can be queried for a tenant by default.NOTE:The bandwidth scaling policy configured for a released EIP still occupies the quota of bandwidth scaling policy. The policy is only visible to the Huawei Cloud account and its IAM users with the global permissions." - operationId: "ListAllScalingV2Policies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_resource_id" - in: "query" - description: "Specifies the scaling resource ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_resource_type" - in: "query" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - required: false - type: "string" - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - x-order: 4 - x-example: "SCALING_GROUP" - - name: "scaling_policy_name" - in: "query" - description: "Specifies the AS policy name." - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 5 - x-example: "test" - - name: "scaling_policy_type" - in: "query" - description: |- - Specifies the AS policy type. - - ALARM: alarm policy - SCHEDULED: scheduled policy - RECURRENCE: periodic policy - required: false - type: "string" - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - x-order: 6 - x-example: "ALARM" - - name: "scaling_policy_id" - in: "query" - description: "Specifies the AS policy ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 7 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - format: "int32" - x-order: 8 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - format: "int32" - x-order: 9 - x-example: 5 - - name: "sort_by" - in: "query" - description: "Specifies the sorting method.POLICY_NAME: AS policies are sorted by name.TRIGGER_CONDITION: AS policies are sorted by trigger condition. For example, in ascending order, alarm policies are first, and others are sorted in ascending order based on the latest triggering time.CREATE_TIME: AS policies are sorted based on the creation time." - required: false - type: "string" - enum: - - "POLICY_NAME" - - "TRIGGER_CONDITION" - - "CREATE_TIME" - x-order: 10 - x-example: "POLICY_NAME" - - name: "order" - in: "query" - description: |- - Specifies the sorting order. - - ASC: ascending order - DESC: descending order - required: false - type: "string" - enum: - - "ASC" - - "DESC" - x-order: 11 - x-example: "ASC" - - name: "enterprise_project_id" - in: "query" - description: "Specifies the enterprise project ID.If scaling_resource_type is set to SCALING_GROUP andall_granted_eps is transferred:When you use an account on Huawei Cloud or its IAM user with global permissions, this API will query scaling policies of the AS groups in all enterprise projects.When you use an IAM user with permissions to specific enterprise projects, this API will query scaling policies of the AS groups in these enterprise projects.NOTE:If the IAM user has permissions to more than 100 enterprise projects, this API will query only the AS policies of AS groups in the first 100 enterprise projects.If scaling_resource_type is set to BANDWIDTH andall_granted_eps is transferred:When you use an account on Huawei Cloud or its IAM user with global permissions, this API will query scaling policies of the bandwidths in all enterprise projects.When you use an IAM user with permissions to specific enterprise projects, this API will query the scaling policies of bandwidths in the enterprise projects specified by all_granted_eps. For details, see Querying Bandwidths in Elastic IP API Reference(https://support.huaweicloud.com/intl/en-us/api-eip/eip_apiBandwidth_0002.html).If scaling_resource_type is not specified andall_granted_eps is transferred:When you use an account on Huawei Cloud or its IAM user with global permissions, this API will query scaling policies of the AS groups and bandwidths in all enterprise projects.When you use an IAM user with permissions to specific enterprise projects, this API will query the scaling policies of AS groups and bandwidths in the enterprise projects.NOTE:If the IAM user has permissions to more than 100 enterprise projects, this API will only query the scaling policies of AS groups in the first 100 enterprise projects, as well as the scaling policies of bandwidths in the enterprise projects specified by all_granted_eps. For details, see Querying Bandwidths(https://support.huaweicloud.com/intl/en-us/api-eip/eip_apiBandwidth_0002.html)." - required: false - type: "string" - x-order: 12 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "alarm_id" - in: "query" - description: "Specifies the alarm rule ID." - required: false - type: "string" - responses: - "200": - description: "Normal" - examples: - application/json: - limit: 20 - total_number: 1 - start_number: 0 - scaling_policies: - - scaling_policy_id: "803a35a5-38fb-4d27-a042-496c14bc1fb8" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "03:30" - recurrence_type: "Daily" - start_time: "2017-08-28T03:08Z" - end_time: "2017-09-01T03:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T03:02:41Z" - schema: - $ref: "#/definitions/AllScalingPolicies" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query all periodic AS policies for resources with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6." - x-support-sdk: "Y" - x-name: "Querying AS Policies (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 7 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy?scaling_resource_id=8ade64b5-d685-40b8-8582-4ce306ea37a6&scaling_policy_type=RECURRENCE" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - post: - tags: - - "AS Policies(V2)" - summary: "Creating an AS Policy (V2)" - description: "This API is used to create an AS policy for an AS group or bandwidth.The difference between the V2 and V1 APIs for creating an AS policy is that V2 supports creating an AS policy for adjusting bandwidth and differentiating scaling resources by their types." - operationId: "CreateScalingV2Policy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingPolicyV2Option" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create an alarm policy named hth_aspolicy_1 with the following configurations: The alarm rule ID is al1513822380493GvlJKZwA8; when the alarm threshold is reached according to the alarm rule, the bandwidth with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6 will be increased by 1 Mbit/s until the bandwidth reaches 10 Mbit/s." - x-support-sdk: "Y" - x-name: "Creating an AS Policy (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy" - x-request-examples-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "BANDWIDTH" - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-request-examples-text-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "BANDWIDTH" - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}: - get: - tags: - - "AS Policies(V2)" - summary: "Querying an AS Policy (V2)" - description: "This API is used to query details about a specified AS policy by policy ID.The difference between the V2 and V1 APIs for querying details of an AS policy is that V2 contains scaling resource types in response messages." - operationId: "ShowScalingV2Policy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy: - scaling_policy_id: "906f73ff-56e8-41b2-a005-8157d0c60361" - scaling_policy_name: "hth_aspolicy_1" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "BANDWIDTH" - scaling_policy_type: "ALARM" - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - limits: 111 - policy_status: "INSERVICE" - create_time: "2018-03-21T08:03:35Z" - meta_data: - metadata_eip_id: "263f0886-de6a-4e21-ad83-814ca9f3844e" - metadata_eip_address: "255.255.255.255" - schema: - $ref: "#/definitions/ScalingV2Policy" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-name: "Querying an AS Policy (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 9 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Policies(V2)" - summary: "Modifying an AS Policy (V2)" - description: "This API is used to modify a specified AS policy.The difference between the V2 and V1 APIs for modifying an AS policy is that V2 supports modifying a scaling resource type." - operationId: "UpdateScalingV2Policy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies an AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScalingV2PolicyOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to modify an AS policy with ID 0h327883-324n-4dzd-9c61-68d03ee191dd. The modification is as follows: The AS policy name is changed to hth_aspolicy_1; the alarm ID is changed to al1513822380493GvlJKZwA8; the cooldown period is changed to 900 seconds; the policy execution action is to add a bandwidth of 1 Mbit/s until the bandwidth reaches 10 Mbit/s." - x-support-sdk: "Y" - x-name: "Modifying an AS Policy (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 4 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd" - x-request-examples-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-request-examples-text-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_resource_id}/list: - get: - tags: - - "AS Policies(V2)" - summary: "Querying AS Policies (V2)" - description: "This API is used to query AS policies based on search criteria. The results are displayed by page.The difference between the V2 and V1 APIs for querying AS policies is that V2 contains scaling resource types in response messages.Search criteria can be the AS policy name, policy type, policy ID, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS policies for specified resources can be queried for a tenant by default." - operationId: "ListScalingV2Policies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_resource_id" - in: "path" - description: "Specifies the scaling resource ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_policy_name" - in: "query" - description: "Specifies the AS policy name." - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 4 - x-example: "test" - - name: "scaling_policy_type" - in: "query" - description: |- - Specifies the AS policy type. - - ALARM: alarm policy - SCHEDULED: scheduled policy - RECURRENCE: periodic policy - required: false - type: "string" - x-order: 5 - - name: "scaling_policy_id" - in: "query" - description: "Specifies the AS policy ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 6 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - format: "int32" - x-order: 7 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value range is 0 to 100." - required: false - type: "integer" - maximum: 100 - minimum: 0 - x-order: 8 - x-example: 5 - responses: - "200": - description: "Normal" - examples: - application/json: - limit: 20 - total_number: 3 - start_number: 0 - scaling_policies: - - scaling_policy_id: "803a35a5-38fb-4d27-a042-496c14bc1fb8" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "03:30" - recurrence_type: "Daily" - start_time: "2017-08-28T03:08Z" - end_time: "2017-09-01T03:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T03:02:41Z" - - scaling_policy_id: "535fd67e-276b-409c-879e-52f4e09e14bb" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "21:30" - recurrence_type: "Daily" - start_time: "2017-08-28T21:08Z" - end_time: "2017-09-01T21:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T07:35:05Z" - - scaling_policy_id: "37df92f8-73cb-469e-a420-c15f445d2ee1" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "22:30" - recurrence_type: "Daily" - start_time: "2017-08-28T22:08Z" - end_time: "2017-09-01T22:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T07:41:06Z" - schema: - $ref: "#/definitions/QueryScalingPolicyListV2Response" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query all periodic AS policies for resources with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6." - x-support-sdk: "Y" - x-name: "Querying AS Policies (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 6 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/8ade64b5-d685-40b8-8582-4ce306ea37a6/list?scaling_policy_type=RECURRENCE" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy_execute_log/{scaling_policy_id}: - get: - tags: - - "AS Policy Execution Logs" - summary: "Querying AS Policy Execution Logs" - description: "This API is used to query the historical records of AS policy execution based on search criteria. The results are displayed by page.Search criteria can be the log ID, AS resource type, AS resource ID, policy execution type, start time, end time, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS policy execution logs can be queried by default." - operationId: "ListScalingPolicyExecuteLogs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - x-order: 2 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "log_id" - in: "query" - description: "Specifies the ID of an AS policy execution log." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 4 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_resource_type" - in: "query" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - required: false - type: "string" - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - x-order: 5 - x-example: "SCALING_GROUP" - - name: "scaling_resource_id" - in: "query" - description: "Specifies the scaling resource ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 6 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "execute_type" - in: "query" - description: |- - Specifies the AS policy execution type. - - SCHEDULED: automatically triggered at a specified time point - RECURRENCE: automatically triggered at a specified time period - ALARM: alarm-triggered - MANUAL: manually triggered - INTERVAL_ALARM: automatically triggered by a refined scaling policy - required: false - type: "string" - enum: - - "SCHEDULED" - - "RECURRENCE" - - "ALARM" - - "MANUAL" - x-order: 7 - x-example: "SCHEDULED" - - name: "start_time" - in: "query" - description: "Specifies the start time that complies with UTC for querying AS policy execution logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 8 - x-example: "2019-03-18T16:00:11Z" - - name: "end_time" - in: "query" - description: "Specifies the end time that complies with UTC for querying AS policy execution logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 9 - x-example: "2019-03-18T16:00:11Z" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - format: "int32" - x-order: 10 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value range is 0 to 100." - required: false - type: "integer" - default: 20 - maximum: 100 - x-order: 11 - x-example: 5 - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/PolicyExecuteLogs" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-text-1: "This example shows how to query the AS policy execution log with ID 05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6." - x-request-examples-1: "This example shows how to query the AS policy execution log with ID 05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6." - x-support-sdk: "Y" - x-name: "Querying AS Policy Execution Logs" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/edcb94a885a84ed3a3fdf8ea4d2741da/scaling_policy_execute_log/05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: 78 - x-source: "SelfDeveloped" - x-timeout: "10s" - x-hybridcloud: 1 - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: 1 - x-ctc: "N" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/list: - get: - tags: - - "Instances" - summary: "Querying Instances in an AS Group" - description: "This API is used to query instances in an AS group based on search criteria. The results are displayed by page.Search criteria can be the instance lifecycle status, instance health status, instance protection status, start line number, and number of records in the AS group.If no search criteria are specified, a maximum of 20 instances in an AS group can be queried by default." - operationId: "ListScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "life_cycle_state" - in: "query" - description: "Specifies the instance lifecycle status in the AS group.INSERVICE: The instance is enabled.PENDING: The instance is being added to the AS group.PENDING_WAIT: The instance is waiting to be added to the AS group.REMOVING: The instance is being removed from the AS group.REMOVING_WAIT: The instance is waiting to be removed from the AS group.STANDBY: The instance is in standby state.ENTERING_STANDBY: The instance is entering the standby state." - required: false - type: "string" - enum: - - "INSERVICE" - - "PENDING" - - "REMOVING" - - "PENDING_WAIT" - - "REMOVING_WAIT" - - "STANDBY" - - "ENTERING_STANDBY" - x-order: 4 - x-example: "REMOVING_WAIT" - - name: "health_status" - in: "query" - description: |- - Specifies the instance health status. - - INITIALIZING: The instance is initializing. - NORMAL: The instance is normal. - ERROR: The instance is abnormal. - required: false - type: "string" - enum: - - "INITIALIZING" - - "NORMAL" - - "ERROR" - x-order: 5 - x-example: "INITIALIZING" - - name: "protect_from_scaling_down" - in: "query" - description: |- - Specifies the instance protection status. - - true: Instance protection is enabled. - false: Instance protection is disabled. - required: false - type: "string" - enum: - - "true" - - "false" - x-order: 6 - x-example: "true" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - format: "int32" - x-order: 7 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - default: 20 - format: "int32" - x-order: 8 - x-example: 10 - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingInstances" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query enabled, healthy instances in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-name: "Querying Instances in an AS Group" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?life_cycle_state=INSERVICE&health_status=NORMAL" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 78 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group_instance/{instance_id}: - delete: - tags: - - "Instances" - summary: "Removing an Instance from an AS Group" - description: "This interface is used to remove a specified instance from an AS group.You can remove instances only in INSERVICE state and only when the number of instances after the removal is greater than or equal to the minimum number of instances allowed.You can remove instances from an AS group only when no scaling action is in progress." - operationId: "DeleteScalingInstance" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "instance_id" - in: "path" - description: "Specifies the instance ID. For details, see Querying Instances in an AS Group(https://support.huaweicloud.com/intl/en-us/api-as/as_06_0301.html)." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "instance_delete" - in: "query" - description: "Specifies whether an instance is deleted when it is removed from the AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted." - required: false - type: "string" - default: "no" - enum: - - "yes" - - "no" - x-order: 4 - x-example: "yes" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to remove but not delete the instance with ID b25c1589-c96c-465b-9fef-d06540d1945c from an AS group." - x-support-sdk: "Y" - x-name: "Removing an Instance from an AS Group" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/b25c1589-c96c-465b-9fef-d06540d1945c?instance_delete=no" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 26 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 260 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action: - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchAddScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters¡£" - required: true - schema: - $ref: "#/definitions/BatchAddInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to add instances with IDs instance_id_1 and instance_id_2 from the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a in a batch." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: - action: "ADD" - instances_id: - - "instance_id_1" - - "instance_id_2" - x-request-examples-text-1: - action: "ADD" - instances_id: - - "instance_id_1" - - "instance_id_2" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchRemoveScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters¡£" - required: true - schema: - $ref: "#/definitions/BatchRemoveInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"REMOVE\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ], \"instance_delete\": \"yes\"}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"REMOVE\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ], \"instance_delete\": \"yes\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "02 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchProtectScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters¡£" - required: true - schema: - $ref: "#/definitions/BatchProtectInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"PROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"PROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "03 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchUnprotectScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters¡£" - required: true - schema: - $ref: "#/definitions/BatchUnprotectInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"UNPROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"UNPROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "04 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchSetScalingInstancesStandby" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters¡£" - required: true - schema: - $ref: "#/definitions/BatchEnterStandbyInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"ENTER_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"ENTER_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "05 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchUnsetScalingInstancesStantby" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters¡£" - required: true - schema: - $ref: "#/definitions/BatchExitStandByInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"EXIT_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"EXIT_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}: - post: - tags: - - "Lifecycle Hooks" - summary: "Creating a Lifecycle Hook" - description: "This interface is used to create a lifecycle hook for an AS group. Up to five lifecycle hooks can be created for one AS group.After the creation, when the AS group performs a scaling action, the lifecycle hook suspends the target instance and sets it to be in Wait (Adding to AS group) or Wait (Removing from AS group) status. This status retains until the timeout duration expires or you manually call back this status.During the instance waiting duration, you can perform customized operations. For example, you can install or configure software on a newly started instance, or download the log file from the instance before the instance terminates." - operationId: "CreateLifyCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateLifeCycleHookOption" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2019-03-18T16:00:11Z" - schema: - $ref: "#/definitions/LifeCycleHookResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create a lifecycle hook named test-hook1 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. The configuration is as follows: The callback operation is ABANDON; the timeout duration is 3600 seconds; the notification topic_urn is urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh; the hook suspends the instance when the instance is started." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Creating a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: "1 " - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-request-examples-1: - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - x-request-examples-text-1: - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/list: - get: - tags: - - "Lifecycle Hooks" - summary: "Querying Lifecycle Hooks" - description: "This interface is used to query lifecycle hooks by AS group ID." - operationId: "ListLifeCycleHooks" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hooks: - - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2016-11-18T04:01:34Z" - - lifecycle_hook_name: "test-hook2" - default_result: "CONTINUE" - default_timeout: 300 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:test" - notification_topic_name: "test" - lifecycle_hook_type: "INSTANCE_TERMINATING" - create_time: "2016-11-17T04:00:34Z" - schema: - $ref: "#/definitions/QueryLifecycleHookListResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the lifecycle hooks of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Lifecycle Hooks" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/{lifecycle_hook_name}: - get: - tags: - - "Lifecycle Hooks" - summary: "Querying a Lifecycle Hook" - description: "This interface is used to query details about a specified lifecycle hook by AS group ID and lifecycle hook name." - operationId: "ShowLifeCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "lifecycle_hook_name" - in: "path" - description: "Specifies the lifecycle hook name." - required: true - type: "string" - x-order: 3 - x-example: "test" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hook_name: "test-hook1" - default_result: "CONTINUE" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2016-11-18T04:01:34Z" - schema: - $ref: "#/definitions/LifeCycleHookResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the lifecycle hook named test-hook1 of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 3 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "Lifecycle Hooks" - summary: "Modifying a Lifecycle Hook" - description: "This interface is used to modify the information about a specified lifecycle hook." - operationId: "UpdateLifeCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "lifecycle_hook_name" - in: "path" - description: "Specifies the lifecycle hook name." - required: true - type: "string" - maxLength: 64 - minLength: 1 - x-order: 4 - x-example: "test" - - in: "body" - name: "bodyparam" - description: "Bodyparameters" - required: true - schema: - $ref: "#/definitions/UpdateLifeCycleHookOption" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hook_name: "test-hook1" - default_result: "CONTINUE" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2016-11-18T04:01:34Z" - schema: - $ref: "#/definitions/LifeCycleHookResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to change the callback operation of the lifecycle hook named test-hook1 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a to CONTINUE." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Modifying a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 4 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1" - x-request-examples-1: - default_result: "CONTINUE" - x-request-examples-text-1: - default_result: "CONTINUE" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "Lifecycle Hooks" - summary: "Deleting a Lifecycle Hook" - description: "This interface is used to delete a specified lifecycle hook.When a scaling action is being performed in an AS group, the lifecycle hooks of the AS group cannot be deleted." - operationId: "DeleteLifecycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "lifecycle_hook_name" - in: "path" - description: "Specifies the lifecycle hook name." - required: true - type: "string" - x-order: 4 - x-example: "test" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the lifecycle hook named test-hook1 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 6 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_instance_hook/{scaling_group_id}/callback: - put: - tags: - - "Lifecycle Hooks" - summary: "Calling Back a Lifecycle Hook" - description: "This interface is used to call back the lifecycle hook specified by a scaling instance based on the lifecycle action key or based on the instance ID and lifecycle hook name.If your custom operations were successful before the timeout duration elapses, select Abandon or Continue to complete the lifecycle action.If you require more time to complete your custom operations, select Extend Timeout to enable the instance to remain in a wait state for an additional hour.The callback operation can be performed only when the lifecycle hook of the target instance is in HANGING state." - operationId: "AttachCallbackInstanceLifeCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "Bodyparameters" - required: true - schema: - $ref: "#/definitions/CallbackLifeCycleHookOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to use lifecycle token 23880867-6288-4470-98a8-f8bda096b6c4 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a to perform the ABANDON callback operation." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Calling Back a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 5 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_instance_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/callback" - x-request-examples-1: - lifecycle_action_result: "ABANDON" - lifecycle_action_key: "23880867-6288-4470-98a8-f8bda096b6c4" - x-request-examples-text-1: - lifecycle_action_result: "ABANDON" - lifecycle_action_key: "23880867-6288-4470-98a8-f8bda096b6c4" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_instance_hook/{scaling_group_id}/list: - get: - tags: - - "Lifecycle Hooks" - summary: "Querying Instance Suspension" - description: "After a lifecycle hook is added, when an AS group performs a scaling action, the lifecycle hook suspends the target instance and sets it to be in waiting state. You can query the instance suspension based on search criteria.Search instance suspension by instance ID.If no search criteria are specified, the suspension about all instances in the specified AS group is queried by default." - operationId: "ListHookInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "instance_id" - in: "query" - description: "Specifies the AS instance ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - x-order: 1 - responses: - "200": - description: "Normal" - examples: - application/json: - instance_hanging_info: - - instance_id: "b25c1589-c96c-465b-9fef-d06540d1945c" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - lifecycle_hook_name: "hook-test" - lifecycle_action_key: "6ebe6e72-4b09-4adb-ae4a-a91dc0560069" - default_result: "ABANDON" - timeout: "2016-11-15T06:43:41Z" - lifecycle_hook_status: "HANGING" - schema: - $ref: "#/definitions/InstanceListResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the suspension of the instance with ID b25c1589-c96c-465b-9fef-d06540d1945c in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Instance Suspension" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 6 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_instance_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?instance_id=b25c1589-c96c-465b-9fef-d06540d1945c" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id}: - get: - tags: - - "Notifications" - summary: "Querying an AS Group Notification List" - description: "This API is used to query an AS group notification list by group ID." - operationId: "ListScalingNotifications" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - topics: - - topic_name: "gsh" - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - - topic_name: "asdf" - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:asdf" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - schema: - $ref: "#/definitions/ListScalingNotificationsResult" - "400": - description: "Bad Request The server failed to process the request." - "401": - description: "Unauthorized You must enter the username and password to access the requested page." - "403": - description: "Forbidden You are forbidden to access the requested page." - "404": - description: "Not Found The server could not find the requested page." - "405": - description: "Method Not Allowed You are not allowed to use the method specified in the request." - "406": - description: "Not Acceptable The response generated by the server could not be accepted by the client." - "407": - description: "Proxy Authentication You must use the proxy server for authentication so that the request can be processed." - "408": - description: "Request Timeout The request timed out." - "409": - description: "Conflict The request could not be processed due to a conflict." - "500": - description: "Internal Server Error Failed to complete the request because of an internal service error." - "501": - description: "Not Implemented Failed to complete the request because the server does not support the requested function." - "502": - description: "Bad Gateway Failed to complete the request because the request is invalid." - "503": - description: "Service Unavailable Failed to complete the request because the system is unavailable." - "504": - description: "Gateway Timeout A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the notification list of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying an AS Group Notification List" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "Notifications" - summary: "Enabling Notification for an AS Group" - description: "This API is used to enable notification for an AS group. Each time this API is called, the AS group adds a notification topic and scenario. Each AS group supports up to five topics. The notification topic is pre-configured and subscribed by you in SMN. When the live network complies with the notification scenario that matches the notification topic, the AS group sends a notification to your subscription endpoints.¡£" - operationId: "CreateScalingNotification" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateNotificationOption" - responses: - "200": - description: "Normal" - examples: - application/json: - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - topic_name: "gsh" - schema: - $ref: "#/definitions/CreateNotificationResult" - "400": - description: "Bad Request The server failed to process the request." - "401": - description: "Unauthorized You must enter the username and password to access the requested page." - "403": - description: "Forbidden You are forbidden to access the requested page." - "404": - description: "Not Found The server could not find the requested page." - "405": - description: "Method Not Allowed You are not allowed to use the method specified in the request." - "406": - description: "Not Acceptable The response generated by the server could not be accepted by the client." - "407": - description: "Proxy Authentication You must use the proxy server for authentication so that the request can be processed." - "408": - description: "Request Timeout The request timed out." - "409": - description: "Conflict The request could not be processed due to a conflict." - "500": - description: "Internal Server Error Failed to complete the request because of an internal service error." - "501": - description: "Not Implemented Failed to complete the request because the server does not support the requested function." - "502": - description: "Bad Gateway Failed to complete the request because the request is invalid." - "503": - description: "Service Unavailable Failed to complete the request because the system is unavailable." - "504": - description: "Gateway Timeout A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to enable notification with topic_urn urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh for the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. After the configuration, a notification will be sent when capacity expansion succeeds or fails, capacity reduction succeeds or fails, or an error occurs in the AS group." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Enabling Notification for an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-request-examples-1: - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - x-request-examples-text-1: - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id}/{topic_urn}: - delete: - tags: - - "Notifications" - summary: "Deleting a Notification for an AS Group" - description: "This interface is used to delete a notification for a specified AS group." - operationId: "DeleteScalingNotification" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "topic_urn" - in: "path" - description: "Specifies a unique topic in SMN." - required: true - type: "string" - x-order: 4 - x-example: "urn:smn:regionId:b53e5554fad0494d96206fxxxxx6510b:xxx" - responses: - "204": - description: "Normal" - "400": - description: "Bad Request The server failed to process the request." - "401": - description: "Unauthorized You must enter the username and password to access the requested page." - "403": - description: "Forbidden You are forbidden to access the requested page." - "404": - description: "Not Found The server could not find the requested page." - "405": - description: "Method Not Allowed You are not allowed to use the method specified in the request." - "406": - description: "Not Acceptable The response generated by the server could not be accepted by the client." - "407": - description: "Proxy Authentication You must use the proxy server for authentication so that the request can be processed." - "408": - description: "Request Timeout The request timed out." - "409": - description: "Conflict The request could not be processed due to a conflict." - "500": - description: "Internal Server Error Failed to complete the request because of an internal service error." - "501": - description: "Not Implemented Failed to complete the request because the server does not support the requested function." - "502": - description: "Bad Gateway Failed to complete the request because the request is invalid." - "503": - description: "Service Unavailable Failed to complete the request because the system is unavailable." - "504": - description: "Gateway Timeout A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the notification with topic_urn urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting a Notification for an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/quotas: - get: - tags: - - "Quotas" - summary: "Querying AS Quotas" - description: "This API is used to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant." - operationId: "ShowResourceQuota" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - responses: - "200": - description: "Normal" - examples: - application/json: - quotas: - resources: - - type: "scaling_Group" - used: 2 - quota: 25 - max: 50 - - type: "scaling_Config" - used: 3 - quota: 100 - max: 200 - - type: "scaling_Policy" - used: -1 - quota: 50 - max: 50 - - type: "scaling_Instance" - used: -1 - quota: 200 - max: 1000 - - type: "bandwidth_scaling_policy" - used: 1 - quota: 10 - max: 100 - schema: - $ref: "#/definitions/QuotaResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Quotas" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/quotas/{scaling_group_id}: - get: - tags: - - "Quotas" - summary: "Querying AS Policy and Instance Quotas" - description: "This interface is used to query the total quotas and used quotas of AS policies and instances of a specified AS group by group ID." - operationId: "ShowPolicyAndInstanceQuota" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - quotas: - resources: - - type: "scaling_Policy" - used: 2 - quota: 50 - max: 50 - - type: "scaling_Instance" - used: 0 - quota: 200 - max: 1000 - schema: - $ref: "#/definitions/PolicyInstanceQuotaResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the total quotas and used quotas of the AS policies and instances in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Policy and Instance Quotas" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_activity_log/{scaling_group_id}: - get: - tags: - - "Scaling Action Logs" - summary: "Querying Scaling Action Logs" - description: "This API is used to query scaling action logs based on search criteria. The results are displayed by page.Search criteria can be the start time, end time, start line number, and number of records.If no search criteria are specified, a maximum of 20 scaling action logs can be queried by default." - operationId: "ListScalingActivityLogs" - consumes: - - "application/x-www-form-urlencoded" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "start_time" - in: "query" - description: "Specifies the start time that complies with UTC for querying scaling action logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 4 - x-example: "2019-03-18T16:00:11Z" - - name: "end_time" - in: "query" - description: "Specifies the end time that complies with UTC for querying scaling action logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 5 - x-example: "2019-03-18T16:00:11Z" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - format: "int32" - x-order: 6 - x-example: 1 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - default: 20 - maximum: 100 - x-order: 7 - x-example: 5 - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingActivityLogs" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the scaling action logs of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: 1 - x-name: "Querying Scaling Action Logs" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_activity_log/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: 78 - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v2/{project_id}/scaling_activity_log/{scaling_group_id}: - get: - tags: - - "Scaling Action Logs" - summary: "Querying Scaling Action Logs (V2)" - description: "This API is used to query scaling action logs based on search criteria. The scaling actions include increasing instances, setting instances to the standby mode, and migrating instances to balance load. The results are displayed by page.The difference between the V2 and V1 APIs for querying scaling action logs is that V2 displays more detailed action logs, such as ELB migration logs and instance standby logs.Search criteria can be the start time, end time, start line number, number of records, and scaling action type.If no search criteria are specified, a maximum of 20 scaling action logs can be queried by default." - operationId: "ListScalingActivityV2Logs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "log_id" - in: "query" - description: "Specifies the scaling action log ID." - required: false - type: "string" - - name: "start_time" - in: "query" - description: "Specifies the start time that complies with UTC for querying scaling action logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 4 - x-example: "2019-03-18T16:00:11Z" - - name: "end_time" - in: "query" - description: "Specifies the end time that complies with UTC for querying scaling action logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 5 - x-example: "2019-03-18T16:00:11Z" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - maximum: 32768 - x-order: 6 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - default: 20 - maximum: 100 - x-order: 7 - x-example: 5 - - name: "type" - in: "query" - description: "Specifies the types of the scaling actions to be queried. Different types are separated by commas (,).NORMAL: indicates a common scaling action.MANUAL_REMOVE: indicates manually removing instances from an AS group.MANUAL_DELETE: indicates manually removing and deleting instances from an AS group.MANUAL_ADD: indicates manually adding instances to an AS group.ELB_CHECK_DELETE: indicates that instances are removed from an AS group and deleted based on the ELB health check result.AUDIT_CHECK_DELETE: indicates that instances are removed from an AS group and deleted based on the OpenStack audit.DIFF: indicates that the number of expected instances is different from the actual number of instances.MODIFY_ELB: indicates the load balancer migration.ENTER_STANDBY: indicates setting instances to standby mode.EXIT_STANDBY: indicates canceling standby mode for instances." - required: false - type: "string" - enum: - - "NORMAL" - - "MANNUAL_REMOVE" - - "MANNUAL_DELETE" - - "MANNUAL_ADD" - - "ELB_CHECK_DELETE" - - "AUDIT_CHECK_DELETE" - - "MODIFY_ELB" - x-order: 8 - x-example: "NORMAL" - - name: "status" - in: "query" - description: |- - Specifies the status of the scaling action. - - SUCCESS: The scaling action has been performed. - FAIL: Performing the scaling action failed. - DOING: The scaling action is being performed. - required: false - type: "string" - enum: - - "SUCCESS" - - "FAIL" - - "DOING" - x-example: "DOING" - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingActivityV2Logs" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the scaling action logs of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. The start time is 2018-11-22T00:00:00Z, and the end time is 2018-11-22T14:00:00Z." - x-support-sdk: "Y" - x-name: "Querying Scaling Action Logs (V2)" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_activity_log/e5d27f5c-dd76-4a61-b4bc-a67c5686719a?start_time=2018-11-22T00:00:00Z&end_time=2018-11-22T14:00:00Z" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: 78 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: 1 - x-ctc: "N" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/{resource_type}/tags: - get: - tags: - - "Tags" - summary: "Querying Tags" - description: "This API is used to query tags of a specific type of resource in a project." - operationId: "ListScalingTagInfosByTenantId" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 3 - x-example: "scaling_group_tag" - responses: - "200": - description: "Normal" - examples: - application/json: - tags: - - key: "ENV15" - values: - - "ENV15" - - key: "111" - values: - - "" - - key: "environment" - values: - - "DEV" - - key: "ENV151" - values: - - "ENV151" - - key: "ENV152" - values: - - "ENV152" - schema: - $ref: "#/definitions/ShowTagByTenantResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query tags of AS groups in a project." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Tags" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/tags" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-08-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags: - get: - tags: - - "Tags" - summary: "Querying Tags of a Resource" - description: "This interface is used to query tags of a specified resource in a project." - operationId: "ListScalingTagInfosByResourceId" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 2 - x-example: "scaling_group_tag" - - name: "resource_id" - in: "path" - description: "Specifies the resource ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - tags: - - key: "ENV15" - value: "ENV15" - - key: "ENV151" - value: "ENV151" - - key: "ENV152" - value: "ENV152" - schema: - $ref: "#/definitions/QueryTagByResourceIdResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the tags of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Tags of a Resource" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags" - x-request-examples-text-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-08-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/{resource_type}/resource_instances/action: - post: - tags: - - "Tags" - summary: "Querying Resources by Tag" - description: "This API is used to query resources in a project by tag.By default, resources and resource tags are in descending order of their creation time." - operationId: "ListResourceInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - - name: "resource_type" - in: "path" - description: "Specifies the resource type. An example value is scaling_group_tag." - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 2 - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/QueryTagsOption" - responses: - "200": - description: "Normal" - examples: - application/json: - resources: - - resource_id: "64af4b6f-ec51-4436-8004-7a8f30080c87" - resource_detail: "SCALING_GROUP_TAG" - tags: - - key: "key" - value: "value" - resource_name: "as_scaling_group_1" - - resource_id: "7122ef51-604b-40e7-b9b2-1de4cd78dc60" - resource_detail: "SCALING_GROUP_TAG" - tags: - - key: "key" - value: "value" - resource_name: "as_scaling_group_2" - marker: "2" - total_count: 2 - schema: - $ref: "#/definitions/QueryTagsResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "Example request when action is set to filterThis example shows how to query AS groups of a tenant using the following search criteria: including tag (key = key1 and value = value), excluding tag (key = key2 and value = value2), index position 100, and maximum number of records 100." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Resources by Tag" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 4 - x-request-examples-url-1: "POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action" - x-request-examples-1: "{\n offset: \"100\"\n limit: \"100\"\n action: \"filter\"\n matches:\n - key: \"resource_name\"\n value: \"resource1\"\n not_tags: \n - key: \"key2\"\n values: \"values2\"\n tags:\n - key: \"key1\"\n values: \"values1\"\n}" - x-request-examples-text-1: "{\n offset: \"100\"\n limit: \"100\"\n action: \"filter\"\n matches:\n - key: \"resource_name\"\n value: \"resource1\"\n not_tags: \n - key: \"key2\"\n values: \"values2\"\n tags:\n - key: \"key1\"\n values: \"values1\"\n}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags/action: - post: - tags: - - "Tags" - summary: "This API is used to create or delete a tag. Each AS group can have a maximum of 10 tags added to it." - description: |- - This API is used to create or delete a tag. - - Each AS group can have a maximum of 10 tags added to it. - operationId: "CreateScalingTagInfo" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 3 - - name: "resource_id" - in: "path" - description: "Resource ID" - required: true - type: "string" - x-order: 4 - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateTagsOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to add two tags (key = ENV15 and value = ENV15) and (key = ENV151 and value = ENV151) to the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Creating or Deleting a Tag" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 3 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action" - x-request-examples-1: - tags: - - key: "ENV15" - value: "ENV15" - - key: "ENV151" - value: "ENV151" - action: "create" - x-request-examples-text-1: - tags: - - key: "ENV15" - value: "ENV15" - - key: "ENV151" - value: "ENV151" - action: "create" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags/action": - post: - tags: - - "Tags" - summary: "Creating or Deleting a Tag" - description: "Creating or Deleting a Tag" - operationId: "DeleteScalingTagInfo" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 3 - - name: "resource_id" - in: "path" - description: "Resource ID" - required: true - type: "string" - x-order: 4 - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/DeleteTagsOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Creating or Deleting a Tag" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 3 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action { \"tags\":[ { \"key\": \"ENV15\", \"value\": \"ENV15\" }, { \"key\": \"ENV151\", \"value\": \"ENV151\" } ], \"action\": \"delete\" }" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action { \"tags\":[ { \"key\": \"ENV15\", \"value\": \"ENV15\" }, { \"key\": \"ENV151\", \"value\": \"ENV151\" } ], \"action\": \"delete\" }" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks: - get: - tags: - - "AS Group ScheduledTask" - summary: "Querying AS Scheduled Tasks" - description: "This API is used to query AS scheduled tasks based on search criteria. The results are displayed by page. Currently, the Search criteria only supports scaling group id. If no search criteria are specified, a maximum of 20 AS scheduled tasks for all AS group can be queried for a tenant by default." - operationId: "ListGroupScheduledTasks" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - required: true - type: "string" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "limit" - in: "query" - description: "Specifies count limit for query result." - required: false - type: "integer" - x-order: 4 - x-example: 20 - - name: "marker" - in: "query" - description: "Specifies page marker for query." - required: false - type: "string" - x-order: 5 - x-example: "xxxxxxx" - responses: - "200": - description: "Normal" - examples: - application/json: - page_info: - next_marker: "xxxx" - scheduled_tasks: - - task_id: "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - name: "task_01" - status: "INSERVICE" - scheduled_policy: - start_time: "2016-01-08T17:31Z" - end_time: "2016-02-08T17:31Z" - launch_time: "16:00" - recurrence_type: "Daily" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - instance_number: - max: 10 - schema: - $ref: "#/definitions/ScheduledTasksResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query scheduled tasks in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Scheduled Tasks" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "GET https://{Endpoint} /autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - post: - tags: - - "AS Group ScheduledTask" - summary: "Creating an AS Scheduled Task" - description: "'This API is used to create an AS scheduled task. An AS scheduled task defines scheduled policy and corresponding action for an AS Group. Tasks are triggered automatically to perform action that adjusts max instance number and min instance number of AS group. Currently, AS scheduled task supports the following policies: periodic policy and point-in-time policy.'" - operationId: "CreateGroupScheduledTask" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScheduledTaskOption" - responses: - "200": - description: "Normal" - examples: - application/json: - task_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScheduledTaskId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-request-examples-text-1: - name: "as-scheduled-task-7a75" - scheduled_policy: - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - launch_time: "16:00" - recurrence_type: "DAILY" - instance_number: - max: 10 - min: 5 - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create a periodic AS task named scheduled-task-7a75. The task takes effect from 2015-12-14T03:34Z through 2015-12-27T03:34Z. During this period, the max instance number will be set to AS group with ID 5bc3aa02-b83e-454c-aba1-4d2095c68f8b at 16:00 every day." - x-support-sdk: "Y" - x-name: "Creating an AS Scheduled Task" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks" - x-request-examples-1: - name: "as-scheduled-task-7a75" - scheduled_policy: - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - launch_time: "16:00" - recurrence_type: "DAILY" - instance_number: - max: 10 - min: 5 - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks/{scheduled_task_id}: - put: - tags: - - "AS Group ScheduledTask" - summary: "Modifying an AS Scheduled Task" - description: "Modifying an AS Scheduled Task" - operationId: "UpdateGroupScheduledTask" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the group ID." - required: true - type: "string" - - name: "scheduled_task_id" - in: "path" - description: "Specifies an AS scheduled task ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScheduledTaskOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-request-examples-text-1: - name: "task_01" - scheduled_policy: - start_time: "2016-01-08T17:31Z" - end_time: "2016-02-08T17:31Z" - launch_time: "16:00" - recurrence_type: "Daily" - instance_number: - max: 10 - min: 5 - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to modify the scheduled task with ID 0h327883-324n-4dzd-9c61-68d03ee191dd for an AS group with two instances. The modification is as follows: The AS scheduled task name is changed to task_01, and the modification is executed at 16:00 every day from 2016-01-08T17:31Z through 2016-02-08T17:31Z." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Modifying an AS Scheduled Task" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "PUT https://{Endpoint} /autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks/0h327883-324n-4dzd-9c61-68d03ee191dd" - x-request-examples-1: - name: "task_01" - scheduled_policy: - start_time: "2016-01-08T17:31Z" - end_time: "2016-02-08T17:31Z" - launch_time: "16:00" - recurrence_type: "Daily" - instance_number: - max: 10 - min: 5 - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "AS Group ScheduledTask" - summary: "Deleting an AS Scheduled Task" - description: "This interface is used to delete a specified AS scheduled task." - operationId: "DeleteGroupScheduledTask" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies an AS group ID." - required: true - type: "string" - - name: "scheduled_task_id" - in: "path" - description: "Specifies an AS scheduled task ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS scheduled task with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting an AS Scheduled Task" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 11 - x-request-examples-url-1: "DELETE https://{Endpoint} /autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks/906f73ff-56e8-41b2-a005-8157d0c60361" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" -definitions: - ApiVersions: - type: "object" - properties: - versions: - type: "array" - description: "Specifies the API versions." - items: - $ref: "#/definitions/VersionInfo" - VersionInfo: - type: "object" - properties: - id: - type: "string" - description: "Specifies the API version ID." - enum: - - "v1" - - "v2" - links: - type: "array" - description: "Specifies the API URL." - items: - $ref: "#/definitions/Links" - min_version: - type: "string" - description: "Specifies the earliest supported API version number." - status: - type: "string" - description: |- - Specifies the API version status. - - CURRENT: indicates a primary version. - SUPPORTED: indicates an earlier version which is still supported. - DEPRECATED: indicates a deprecated version which may be deleted later. - enum: - - "CURRENT" - - "SUPPORT" - - "DEPRECATED" - update: - type: "string" - format: "date-time" - description: "Specifies the release date of an API version." - version: - type: "string" - description: "Specifies the latest supported API version number." - Links: - type: "object" - properties: - href: - type: "string" - description: "Specifies the API Uniform Resource Locator (URL)." - rel: - type: "string" - description: "Specifies the API URL dependency." - ApiVersion: - type: "object" - properties: - version: - description: "Specifies a specified API version." - $ref: "#/definitions/VersionInfo" - CreateScalingConfigOption: - type: "object" - properties: - source_scaling_configuration_id: - type: "string" - description: |- - Specifies the ID of the source AS configuration, which will be used together with instance_config to create a new AS configuration. - If instance_id is specified in instance_config, instance_id is preferentially used to create the new AS configuration, and source_scaling_configuration_id does not take effect. - If instance_id is not specified in instance_config, source_scaling_configuration_id and instance_config are used together to create the new AS configuration. - If a parameter in instance_config is set to null, the corresponding setting of the source AS configuration takes effect. - If a parameter in instance_config is not set to null or left empty, this parameter overwrites the corresponding setting of the source AS configuration. - If source_scaling_configuration_id is not specified, scaling_configuration_name and instance_config are mandatory. - minLength: 1 - maxLength: 64 - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_configuration_name: - type: "string" - example: "as-config-tlzq" - description: "Specifies the AS configuration name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - instance_config: - description: "Specifies the ECS configuration." - $ref: "#/definitions/InstanceConfig" - description: "Request parameters" - InstanceConfig: - type: "object" - properties: - instance_id: - type: "string" - description: "Specifies the ECS ID. When using the existing ECS specifications as the template to create AS configurations, specify this parameter. In this case, the flavorRef, imageRef, disk, tenancy, dedicated_host_id, and security_groups fields do not take effect.If the instance_id field is not specified, flavorRef, imageRef, and disk fields are mandatory." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - flavorRef: - type: "string" - description: "Specifies the ECS flavor ID. A maximum of 10 flavors can be selected. Use a comma (,) to separate multiple flavor IDs. You can obtain its value from the API for querying details about flavors and extended flavor information." - minLength: 1 - maxLength: 36 - imageRef: - type: "string" - description: "Specifies the image ID. Its value is the same as that of image_id for specifying the image selected during ECS creation. Obtain the value using the API for querying images. ." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - disk: - type: "array" - description: "Specifies the disk group information. System disks are mandatory and data disks are optional. For details" - items: - $ref: "#/definitions/DiskInfo" - key_name: - type: "string" - description: "Specifies the name of the SSH key pair used to log in to the ECS.NOTE:If both key_name and user_data are specified, user_data only injects user data." - minLength: 1 - maxLength: 32 - personality: - type: "array" - description: "Specifies information about the injected file. Only text files can be injected. A maximum of five files can be injected at a time and the maximum size of each file is 1 KB. For details." - items: - $ref: "#/definitions/PersonalityInfo" - public_ip: - description: "Specifies the EIP of the ECS. The EIP can be configured in two ways. Do not use an EIP. In this case, this parameter is unavailable.Automatically assign an EIP. You need to specify the information about the new EIP." - $ref: "#/definitions/PublicIp" - user_data: - type: "string" - description: "Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.Constraints:The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB.If key_name is not specified, the data injected by user_data is the password of user root for logging in to the ECS by default.This parameter is mandatory when you create a Linux ECS using the password authentication mode. Its value is the initial user root password.Password complexity requirements:Consists of 8 to 26 characters.Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?).NOTE:Data injection is not supported for ECSs that use a Linux image and the password login mode." - metadata: - description: "Specifies the ECS metadata.NOTE:This parameter is mandatory when a Windows ECS with password authentication is created.This parameter does not allow users to write data. It is mandatory when the ECS is to be created using a Windows image." - $ref: "#/definitions/VmMetaData" - security_groups: - type: "array" - description: "Specifies security groups. If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration." - items: - $ref: "#/definitions/SecurityGroups" - server_group_id: - type: "string" - description: "Specifies the ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenancy: - type: "string" - description: |- - Specifies that ECSs are created on DeHs. Options: - - dedicated: Specifies that ECSs are created on DeHs. - This parameter is not specified. - enum: - - "dedicated" - dedicated_host_id: - type: "string" - description: "Specifies the ID of a DeH.NOTE:This parameter is valid only when tenancy is set to dedicated.If this parameter is specified, ECSs will be created on a specified DeH.If this parameter is not specified, the system automatically selects the DeH with the maximum available memory size from the DeHs that meet specifications requirements to create the ECSs, thereby balancing load of the DeHs." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - multi_flavor_priority_policy: - type: "string" - description: "Specifies the priority policy used when there are multiple flavors and instances to be created using an AS configuration.PICK_FIRST (default): When an ECS is added for capacity expansion, the target flavor is determined in the order in the flavorRef list.COST_FIRST: When an ECS is added for capacity expansion, the target flavor is determined for minimal expenses." - enum: - - "PICK_FIRST" - - "COST_FIRST" - market_type: - type: "string" - description: |- - Specifies a billing mode for an ECS. The options are as follows: - - Pay-per-use, which is not specified - Spot pricing - enum: - - "spot" - description: "instance_config field description" - DiskInfo: - type: "object" - required: - - "disk_type" - - "size" - - "volume_type" - properties: - size: - type: "integer" - description: "Specifies the disk size. The unit is GB.The system disk size ranges from 1 to 1024 and must be greater than or equal to the minimum size (min_disk value) of the system disk specified in the image.The data disk size ranges from 10 to 32768." - minimum: 10 - maximum: 32768 - volume_type: - type: "string" - description: "Specifies the ECS system disk type. The disk type must match the available disk type.SATA: common I/O disk typeSAS: high I/O disk typeSSD: ultra-high I/O disk typeGPSSD: general-purpose SSD disk typeco-p1: high I/O (performance-optimized I) disk typeuh-l1: ultra-high I/O (latency-optimized) disk typeIf the specified disk type is not available in the AZ, the disk will fail to create.NOTE:For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks.For details about disk types, see[Disk Types and Disk Performance.](https://support.huaweicloud.com/intl/en-us/productdesc-evs/en-us_topic_0014580744.html)¡£" - enum: - - "SATA" - - "SAS" - - "SSD" - - "co-pl" - - "uh-11" - - "GPSSD" - - "GPSSD2" - - "ESSD2" - default: "SATA" - disk_type: - type: "string" - description: |- - Specifies a disk type. The options are as follows: - - DATA: indicates a data disk. - SYS: indicates a system disk. - NOTE: - System disk encryption is not supported. - enum: - - "SYS" - - "DATA" - default: "SYS" - dedicated_storage_id: - type: "string" - description: "Specifies a DSS device ID for creating an ECS disk.NOTE:Specify DSS devices for all disks in an AS configuration or not. If DSS devices are specified, all the data stores must belong to the same AZ, and the disk types supported by a DSS device for a disk must be the same as the volume_type value." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - data_disk_image_id: - type: "string" - description: "Specifies the ID of a data disk image used to export data disks of an ECS." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - snapshot_id: - type: "string" - description: "Specifies the disk backup snapshot ID for restoring the system disk and data disks using a full-ECS backup when a full-ECS image is used.NOTE:Each disk in an AS configuration must correspond to a disk backup in the full-ECS backup by snapshot_id." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - metadata: - description: "Specifies the metadata for creating disks." - $ref: "#/definitions/MetaData" - iops: - type: "integer" - format: "int32" - description: "Specifies the IOPS configured for an EVS disk. This parameter is mandatory only when volume_type is set to GPSSD2 or ESSD2." - throughput: - type: "integer" - format: "int32" - description: "Specifies the throughput of an EVS disk. The unit is MiB/s. This parameter is mandatory when volumetype is set to GPSSD2 and cannot be configured when volume_type is set to other values." - description: "disk field description" - PersonalityInfo: - type: "object" - required: - - "content" - - "path" - properties: - path: - type: "string" - description: "Specifies the path of the injected file.For Linux OSs, specify the path, for example, /etc/foo.txt, for storing the injected file.For Windows, the injected file is automatically stored in the root directory of drive C. You only need to specify the file name, for example, foo. The file name contains only letters and digits." - content: - type: "string" - description: "Specifies the content of the injected file.The value must be the information after the content of the injected file is encoded using Base64." - description: "personality field description" - PublicIp: - type: "object" - required: - - "eip" - properties: - eip: - description: "Specifies the EIP automatically assigned to the ECS." - $ref: "#/definitions/EipInfo" - description: "public_ip field description" - EipInfo: - type: "object" - required: - - "bandwidth" - - "ip_type" - properties: - ip_type: - type: "string" - description: |- - Specifies the EIP type. - - Enumerated values of the IP address type: - - 5_bgp: indicates the dynamic BGP. - 5_sbgp: indicates the static BGP. - 5_telcom: indicates China Telecom. - 5_union: indicates China Unicom. - enum: - - "5_bgp" - - "5_sbgp" - - "5_telcom" - - "5_union" - bandwidth: - description: "Specifies the bandwidth of an IP address." - $ref: "#/definitions/BandwidthInfo" - description: "eip field description" - BandwidthInfo: - type: "object" - required: - - "share_type" - properties: - size: - type: "integer" - description: "Specifies the bandwidth (Mbit/s). The value range for bandwidth billed by duration is 1 to 2000 and that for bandwidth billed by traffic is 1 to 300.NOTE:If share_type is set to PER, this parameter is mandatory. If share_type is set to WHOLE, this parameter is invalid.The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.The minimum unit for bandwidth varies depending on the bandwidth range.The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included).The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).The minimum unit is 500 Mbit/s if the allowed bandwidth size is greater than 1000 Mbit/s." - minimum: 1 - maximum: 300 - share_type: - type: "string" - description: |- - Specifies the bandwidth sharing type. - - Enumerated values of the sharing type: - - PER: dedicated - WHOLE: shared - enum: - - "PER" - - "WHOLE" - charging_mode: - type: "string" - description: "Specifies the bandwidth billing mode.The options are as follows:bandwidth: billed by bandwidth.traffic: billed by traffic.If the parameter value is out of the preceding options, creating the ECS will fail.NOTE:If share_type is set to PER, this parameter is mandatory.If share_type is set to WHOLE, this parameter is invalid." - enum: - - "bandwidth" - - "traffic" - id: - type: "string" - description: "Specifies the bandwidth ID. When using a shared bandwidth, you can select an existing shared bandwidth to create an EIP.NOTE:If share_type is set to PER, this parameter is invalid.If share_type is set to WHOLE, this parameter is mandatory." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "bandwidth field description" - SecurityGroups: - type: "object" - required: - - "id" - properties: - id: - type: "string" - example: "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" - description: "Specifies the ID of the security group." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "security_groups field description" - ScalingConfigId: - type: "object" - properties: - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - ScalingConfigListResult: - type: "object" - properties: - total_number: - type: "integer" - description: "Specifies the total number of query records." - minimum: 0 - maximum: 100 - start_number: - type: "integer" - description: "Specifies the start line number." - limit: - type: "integer" - description: "Specifies the number of query records." - minimum: 0 - maximum: 100 - scaling_configurations: - type: "array" - description: "Specifies the AS configuration list." - items: - $ref: "#/definitions/ScalingConfiguration" - description: "Response parameters" - ScalingConfiguration: - type: "object" - properties: - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID. This parameter is globally unique." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenant: - type: "string" - description: "Specifies the tenant ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_configuration_name: - type: "string" - example: "config_name_1" - description: "Specifies the AS configuration name." - instance_config: - description: "Specifies the information about instance configurations." - $ref: "#/definitions/InstanceConfigResult" - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when AS configurations are created. The time format complies with UTC." - scaling_group_id: - type: "string" - description: "Specifies the ID of the AS group to which the AS configuration is bound." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "scaling_configurations field description" - InstanceConfigResult: - type: "object" - properties: - flavorRef: - type: "string" - description: "Specifies the ECS flavor ID." - imageRef: - type: "string" - description: "Specifies the image ID. It is same as image_id." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - disk: - type: "array" - description: "Specifies the disk group information." - items: - $ref: "#/definitions/DiskResult" - key_name: - type: "string" - description: "Specifies the name of the SSH key pair used to log in to the ECS." - minLength: 1 - maxLength: 32 - key_fingerprint: - type: "string" - description: "Specifies the fingerprint of the SSH key pair used to log in to the ECS." - instance_name: - type: "string" - description: "This parameter is reserved." - instance_id: - type: "string" - description: "This parameter is reserved." - adminPass: - type: "string" - description: "This parameter is reserved." - personality: - type: "array" - description: "Specifies information about the injected file." - items: - $ref: "#/definitions/PersonalityResult" - public_ip: - description: "Specifies the EIP of the ECS." - $ref: "#/definitions/PublicipResult" - user_data: - type: "string" - description: "Specifies the Cloud-Init user data, which is encoded using Base64." - metadata: - description: "Specifies the ECS metadata." - $ref: "#/definitions/VmMetaData" - security_groups: - type: "array" - description: "Specifies the security group information." - items: - $ref: "#/definitions/SecurityGroups" - server_group_id: - type: "string" - description: "Specifies the ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenancy: - type: "string" - description: "Specifies that ECSs are created on DeHs." - dedicated_host_id: - type: "string" - description: "Specifies the ID of a DeH." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - market_type: - type: "string" - description: "Specifies a billing mode for an ECS, which can be spot pricing or pay-per-use." - multi_flavor_priority_policy: - type: "string" - description: "Specifies the priority policy used when there are multiple flavors and instances to be created using an AS configuration." - description: "instance_config field description" - DiskResult: - type: "object" - properties: - size: - type: "integer" - description: "Specifies the disk size. The unit is GB." - volume_type: - type: "string" - description: "Specifies the disk type." - enum: - - "SATA" - - "SAS" - - "SSD" - - "co-pl" - - "uh-11" - - "GPSSD2" - - "ESSD2" - disk_type: - type: "string" - description: "Specifies whether the disk is a system disk or a data disk. DATA indicates a data disk. SYS indicates a system disk." - enum: - - "SYS" - - "DATA" - dedicated_storage_id: - type: "string" - description: "Specifies the ID of the DSS device for the disk." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - data_disk_image_id: - type: "string" - description: "Specifies the ID of the data disk image for creating a data disk." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - snapshot_id: - type: "string" - description: "Specifies the disk backup snapshot ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - metadata: - description: "Specifies the metadata for creating disks." - $ref: "#/definitions/MetaData" - iops: - type: "integer" - format: "int32" - description: "Specifies the IOPS configured for an EVS disk." - throughput: - type: "integer" - format: "int32" - description: "Specifies the throughput of an EVS disk." - description: "disk field description" - PersonalityResult: - type: "object" - properties: - path: - type: "string" - description: "Specifies the path of the injected file." - content: - type: "string" - description: "Specifies the content of the file to be injected. The file content is encoded using Base64." - description: "personality field description" - PublicipResult: - type: "object" - properties: - eip: - description: "Specifies the automatically assigned EIP." - $ref: "#/definitions/EipResult" - description: "public_ip field description" - EipResult: - type: "object" - properties: - ip_type: - type: "string" - description: "Specifies the IP address type." - enum: - - "5_bgp" - - "5_sbgp" - - "5_telcom" - - "5_union" - bandwidth: - description: "Specifies the bandwidth of an IP address." - $ref: "#/definitions/BandwidthResult" - description: "eip field description" - BandwidthResult: - type: "object" - properties: - size: - type: "integer" - description: "Specifies the bandwidth (Mbit/s)." - minimum: 1 - maximum: 300 - share_type: - type: "string" - description: |- - Specifies the bandwidth sharing type. - - Enumerated values of the sharing type: - - PER: dedicated - WHOLE: shared - enum: - - "PER" - - "WHOLE" - charging_mode: - type: "string" - description: |- - Specifies the bandwidth billing mode. - - traffic: billed by traffic. - enum: - - "bandwidth" - - "traffic" - id: - type: "string" - description: "Specifies the bandwidth ID. You can specify a shared bandwidth when applying for an EIP with the bandwidth whose type is set to WHOLE." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "bandwidth field description" - QueryScalingConfigResult: - type: "object" - properties: - scaling_configuration: - description: "Provides AS configuration details." - $ref: "#/definitions/ScalingConfiguration" - description: "Response parameters" - BatchDeleteScalingConfigOption: - type: "object" - required: - - "scaling_configuration_id" - properties: - scaling_configuration_id: - type: "array" - description: "Specifies the AS configuration ID" - items: - type: "string" - description: "Request parameters" - MetaData: - type: "object" - properties: - __system__encrypted: - type: "string" - description: "Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled).If this parameter does not exist, the disk will not be encrypted by default.NOTE:System disk encryption is not supported." - __system__cmkid: - type: "string" - description: "Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.NOTE:System disk encryption is not supported.For details about how to obtain the CMK ID, see Querying the List of CMKs(https://support.huaweicloud.com/intl/en-us/api-dew/ListKeys.html)." - description: "metadata Field Description for Creating Disks" - VmMetaData: - type: "object" - properties: - admin_pass: - type: "string" - description: "Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator.Password complexity requirements:Consists of 8 to 26 characters.Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?The password cannot contain the username or the username in reversed order.The Windows ECS password cannot contain the username, the username in reversed order, or more than two consecutive characters in the username." - description: "metadata field description" - UpdateScalingConfigOption: - type: "object" - required: - - "instance_config" - properties: - instance_config: - $ref: "#/definitions/UpdateInstanceConfig" - UpdateInstanceConfig: - type: "object" - required: - - "imageRef" - properties: - imageRef: - type: "string" - description: "imageID" - ScalingGroupId: - type: "object" - properties: - scaling_group_id: - type: "string" - example: "a8327883-6b07-4497-9c61-68d03ee193a1" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - CreateScalingGroupOption: - type: "object" - required: - - "networks" - - "scaling_configuration_id" - - "scaling_group_name" - - "vpc_id" - properties: - scaling_group_name: - type: "string" - description: "Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - desire_instance_number: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances. The default value is the minimum number of instances.The value ranges from the minimum number of instances to the maximum number of instances." - min_instance_number: - type: "integer" - format: "int32" - description: "Specifies the minimum number of instances. The default value is 0." - max_instance_number: - type: "integer" - format: "int32" - description: "Specifies the maximum number of instances. The default value is 0." - cool_down_time: - type: "integer" - format: "int32" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.After a scaling action is triggered, the system starts the cooldown period. During the cooldown period, scaling actions triggered by alarms will be denied. Scheduled, periodic, and manual scaling actions are not affected." - maximum: 86400 - lb_listener_id: - type: "string" - description: "Specifies the ID of a classic load balancer listener. You can bind up to six load balancer listeners. Separate listener IDs with commas (,). For details about how to obtain the listener ID, see Querying Load Balancers.This parameter is alternative to lbaas_listeners." - minLength: 1 - maxLength: 36 - lbaas_listeners: - type: "array" - description: "Specifies information about an enhanced load balancer. The system supports the binding of up to six load balancers. This parameter is in list data structure." - items: - $ref: "#/definitions/LbaasListeners" - available_zones: - type: "array" - description: "Specifies the AZ information. The instances added in a scaling action will be created in a specified AZ. If you do not specify an AZ, the system automatically specifies one." - items: - type: "string" - networks: - type: "array" - description: "Specifies network information. The system supports up to five subnets. The first subnet transferred serves as the primary NIC of the ECS by default. This parameter is in data structure." - items: - $ref: "#/definitions/Networks" - security_groups: - type: "array" - description: "Specifies the security group information. A maximum of one security group can be selected. This parameter is in data structure. For details, see Table 5.If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration." - items: - $ref: "#/definitions/SecurityGroup" - vpc_id: - type: "string" - description: "Specifies the VPC ID, which can be obtained using the API for querying VPCs. For details, see \"Querying VPCs\" in Virtual Private Network API Reference." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - health_periodic_audit_method: - type: "string" - description: "Specifies the health check method for instances in the AS group. The health check methods include ELB_AUDIT and NOVA_AUDIT. When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.ELB_AUDIT: indicates the ELB health check, which takes effect in an AS group with a listener.NOVA_AUDIT: indicates the ECS instance health check, which is the health check method delivered with AS." - enum: - - "ELB_AUDIT" - - "NOVA_AUDIT" - health_periodic_audit_time: - type: "integer" - format: "int32" - description: "Specifies the instance health check period. The value can be 1, 5, 15, 60, or 180 in the unit of minutes. If this parameter is not specified, the default value is 5.If the value is set to 0, health check is performed every 10 seconds." - health_periodic_audit_grace_period: - type: "integer" - format: "int32" - description: "Specifies the grace period for instance health check. The unit is second and the value ranges from 0 to 86400. The default value is 600.The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking the instance status only after the grace period ends.This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT." - maximum: 86400 - instance_terminate_policy: - type: "string" - description: "Specifies the instance removal policy.OLD_CONFIG_OLD_INSTANCE (default): The earlier-created instances based on the earlier-created AS configurations are removed first.OLD_CONFIG_NEW_INSTANCE: The later-created instances based on the earlier-created AS configurations are removed first.OLD_INSTANCE: The earlier-created instances are removed first.NEW_INSTANCE: The later-created instances are removed first." - enum: - - "OLD_CONFIG_OLD_INSTANCE" - - "OLD_CONFIG_NEW_INSTANCE" - - "OLD_INSTANCE" - - "NEW_INSTANCE" - notifications: - x-inner: true - type: "array" - description: "Specifies the notification mode.EMAIL refers to notification by email.This notification mode has been canceled. You are advised to configure the notification function for the AS group." - items: - type: "string" - delete_publicip: - type: "boolean" - description: "Specifies whether to delete the EIP bound to the ECS when deleting the ECS. The value can be true or false. The default value is false.true: deletes the EIP bound to the ECS when deleting the ECS. If the EIP is billed on a yearly/monthly basis, it will not be deleted when the ECS is deleted.false: only unbinds the EIP bound to the ECS when deleting the ECS." - delete_volume: - type: "boolean" - description: "Specifies whether to delete the data disks attached to the ECS when deleting the ECS. The value can be true or false. The default value is false.true: deletes the data disks attached to the ECS when deleting the ECS. If the data disks are billed a yearly/monthly basis, they will not be deleted when the ECS is deleted.false: only detaches the data disks attached to the ECS when deleting the ECS." - enterprise_project_id: - type: "string" - description: "Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.If the value is 0 or left blank, the AS group belongs to the default enterprise project.If the value is a UUID, the AS group belongs to the enterprise project corresponding to the UUID.. For how to obtain an enterprise project ID, see Querying Enterprise Projects(https://support.huaweicloud.com/intl/en-us/api-em/en-us_topic_0121230880.html).If an enterprise project is configured for an AS group, ECSs created in this AS group also belong to this enterprise project. Otherwise, the default enterprise project will be used.NOTE:For details about enterprise project features, see Enterprise Project Management User Guide(https://support.huaweicloud.com/intl/en-us/usermanual-em/en-us_topic_0131965280.html)." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - multi_az_priority_policy: - type: "string" - description: "Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.EQUILIBRIUM_DISTRIBUTE (default): When adjusting the number of instances, ensure that instances in each AZ in the available_zones list is evenly distributed. If instances cannot be added in the target AZ, select another AZ based on the PICK_FIRST policy.PICK_FIRST: When adjusting the number of instances, target AZs are determined in the order in the available_zones list." - enum: - - "EQUILIBRIUM_DISTRIBUTE" - - "PICK_FIRST" - iam_agency_name: - type: "string" - description: |- - Specifies the agency name, in 1 to 64 characters. - - iam_agency_name is not transferred if it is set to null. - iam_agency_name is transferred if it is left blank or has a value. - description: - type: "string" - description: "Specifies the description of the AS group. The value can contain 1 to 256 characters." - tags: - type: "array" - description: "Creates tags and adds them the AS group. Each AS group can have a maximum of 10 tags." - items: - $ref: "#/definitions/TagsSingleValue" - description: "Request parameters" - LbaasListeners: - type: "object" - required: - - "pool_id" - - "protocol_port" - - "weight" - properties: - pool_id: - type: "string" - description: "Specifies the backend ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - protocol_version: - type: "string" - description: "Specifies ip protocol version." - enum: - - "IPV4" - - "IPV6" - protocol_port: - type: "integer" - format: "int32" - description: "Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic. The port ID ranges from 1 to 65535." - minimum: 1 - maximum: 65535 - weight: - type: "integer" - format: "int32" - description: "Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener. The value of this parameter ranges from 0 to 100." - description: "lbaas_listeners field description" - Networks: - type: "object" - required: - - "id" - properties: - id: - type: "string" - example: "3cd35bca-5a10-416f-8994-f79169559870" - description: "Specifies the subnet ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - ipv6_enable: - type: "boolean" - description: "Specifies whether to support IPv6 addresses.true: indicates that the NIC supports IPv6 addresses.false: indicates that the NIC does not support IPv6 addresses. The default value is false." - ipv6_bandwidth: - description: "Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no shared IPv6 bandwidth is bound." - $ref: "#/definitions/Ipv6Bandwidth" - allowed_address_pairs: - type: "array" - description: "Specifies whether to allow the system to check the source and destination addresses." - items: - $ref: "#/definitions/AllowedAddressPair" - description: "networks field description" - Ipv6Bandwidth: - type: "object" - required: - - "id" - properties: - id: - type: "string" - description: "Specifies the ID of the shared bandwidth of an IPv6 address." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "ipv6_bandwidth field description" - SecurityGroup: - type: "object" - required: - - "id" - properties: - id: - type: "string" - example: "23b7b999-0a30-4b48-ae8f-ee201a88a6ab" - description: "Specifies the security group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "security_groups field description" - ScalingGroupsResult: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - description: "Specifies the start number of query records." - limit: - type: "integer" - format: "int32" - description: "Specifies the number of query records." - scaling_groups: - type: "array" - description: "Specifies the AS group list." - items: - $ref: "#/definitions/ScalingGroups" - description: "Response parameters" - ScalingGroups: - type: "object" - properties: - scaling_group_name: - type: "string" - description: "Specifies the name of the AS group." - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_status: - type: "string" - description: "Specifies the status of the AS group." - enum: - - "INSERVICE" - - "PAUSED" - - "ERROR" - - "DELETING" - - "FREEZED" - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_configuration_name: - type: "string" - description: "Specifies the AS configuration name." - minLength: 1 - maxLength: 64 - current_instance_number: - type: "integer" - format: "int32" - description: "Specifies the number of current instances in the AS group." - desire_instance_number: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances in the AS group." - min_instance_number: - type: "integer" - format: "int32" - description: "Specifies the minimum number of instances in the AS group." - max_instance_number: - type: "integer" - format: "int32" - description: "Specifies the maximum number of instances in the AS group." - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - lb_listener_id: - type: "string" - description: "Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,)." - minLength: 1 - maxLength: 32 - lbaas_listeners: - type: "array" - description: "Specifies enhanced load balancers." - items: - $ref: "#/definitions/LbaasListenersResult" - available_zones: - type: "array" - description: "Specifies the AZ information." - items: - type: "string" - networks: - type: "array" - description: "Specifies the network information." - items: - $ref: "#/definitions/NetworksResult" - security_groups: - type: "array" - description: "Specifies the security group information." - items: - $ref: "#/definitions/SecurityGroupsResult" - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS group was created. The time format complies with UTC." - vpc_id: - type: "string" - description: "Specifies the ID of the VPC to which the AS group belongs." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - detail: - type: "string" - description: "Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors." - is_scaling: - type: "boolean" - description: "Specifies the scaling flag of the AS group." - health_periodic_audit_method: - type: "string" - description: "Specifies the health check method." - enum: - - "ELB_AUDIT" - - "NOVA_AUDIT" - health_periodic_audit_time: - type: "integer" - format: "int32" - description: "Specifies the health check interval." - health_periodic_audit_grace_period: - type: "integer" - format: "int32" - description: "Specifies the grace period for health check." - maximum: 86400 - instance_terminate_policy: - type: "string" - description: "Specifies the instance removal policy." - enum: - - "OLD_CONFIG_OLD_INSTANCE" - - "OLD_CONFIG_NEW_INSTANCE" - - "OLD_INSTANCE" - - "NEW_INSTANCE" - notifications: - x-inner: true - type: "array" - description: "Specifies the notification mode.EMAIL refers to notification by email.This notification mode has been canceled. You are advised to configure the notification function for the AS group. For details, see Notifications.(https://support.huaweicloud.com/intl/en-us/api-as/as_06_0800.html)" - items: - type: "string" - delete_publicip: - type: "boolean" - description: "Specifies whether to delete the EIP bound to the ECS when deleting the ECS." - delete_volume: - type: "boolean" - description: "Specifies whether to delete the data disks attached to the ECS when deleting the ECS." - cloud_location_id: - type: "string" - description: "This parameter is reserved." - enterprise_project_id: - type: "string" - description: "Specifies the enterprise project ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - activity_type: - type: "string" - description: "Specifies the type of the AS action." - multi_az_priority_policy: - type: "string" - description: "Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group." - iam_agency_name: - type: "string" - description: "Specifies the agency name." - description: - type: "string" - description: "Specifies the description of the AS group." - tags: - type: "array" - description: "Specifies the tags added to the AS group." - items: - $ref: "#/definitions/TagsSingleValue" - description: "scaling_groups field description" - LbaasListenersResult: - type: "object" - properties: - listener_id: - type: "string" - description: "Specifies the listener ID." - pool_id: - type: "string" - description: "Specifies the backend ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - protocol_version: - type: "string" - description: "Specifies ip protocol version." - enum: - - "IPV4" - - "IPV6" - protocol_port: - type: "integer" - format: "int32" - description: "Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic." - minimum: 1 - maximum: 65535 - weight: - type: "integer" - format: "int32" - description: "Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener." - description: "lbaas_listeners field description" - NetworksResult: - type: "object" - properties: - id: - type: "string" - example: "a8327883-6b07-4497-9c61-68d03ee193a" - description: "Specifies the subnet ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - ipv6_enable: - type: "boolean" - description: "Specifies whether to support IPv6 addresses. If this parameter is set to true, the NIC supports IPv6 addresses. The default value is false." - ipv6_bandwidth: - description: "Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no IPv6 shared bandwidth is bound." - $ref: "#/definitions/Ipv6Bandwidth" - allowed_address_pairs: - type: "array" - description: "Specifies whether to allow the system to check the source and destination addresses." - items: - $ref: "#/definitions/AllowedAddressPair" - description: "networks field description" - SecurityGroupsResult: - type: "object" - properties: - id: - type: "string" - example: "8a4b1d5b-0054-419f-84b1-5c8a59ebc829" - description: "Specifies the security group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "security_groups field description" - ScalingGroupResult: - type: "object" - properties: - scaling_group: - description: "Specifies details about the AS group." - $ref: "#/definitions/ScalingGroups" - description: "Response parameters" - UpdateScalingGroupOption: - type: "object" - properties: - scaling_group_name: - type: "string" - description: "Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - desire_instance_number: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances.The value ranges from the minimum number of instances to the maximum number of instances." - min_instance_number: - type: "integer" - format: "int32" - description: "Specifies the minimum number of instances." - max_instance_number: - type: "integer" - format: "int32" - description: "Specifies the maximum number of instances, which is greater than or equal to the minimum number of instances." - cool_down_time: - type: "integer" - format: "int32" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default." - maximum: 86400 - available_zones: - type: "array" - description: "Specifies the AZ information. The instances added in a scaling action will be created in a specified AZ. If you do not specify an AZ, the system automatically specifies one.For details, see Regions and Endpoints.You can change the AZ of an AS group only when no scaling action is being performed in the group." - items: - type: "string" - networks: - type: "array" - description: "Specifies network information. You can select up to five subnets. The first subnet you select is used by the primary NICs of ECSs by default. The value of this parameter can be changed only when all the following conditions are met:No scaling actions are triggered in the AS group.The number of instances in the AS group is 0.The AS group is not in service." - items: - $ref: "#/definitions/Networks" - security_groups: - type: "array" - description: "Specifies the security group. A maximum of one security group can be selected. For how to obtain security group information, see Querying Security Groups. If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration. The value of this parameter can be changed only when all the following conditions are met:No scaling actions are triggered in the AS group.The number of instances in the AS group is 0.The AS group is not in service." - items: - $ref: "#/definitions/SecurityGroup" - lb_listener_id: - type: "string" - description: "Specifies the ID of a classic load balancer listener. The system supports the binding of up to six load balancer listeners, the IDs of which are separated using a comma (,). For details about how to obtain the listener ID, see Querying Load Balancers.The value of this parameter can be changed only when all the following conditions are met:No scaling actions are triggered in the AS group.The number of instances in the AS group is 0.The AS group is not in service." - minLength: 1 - maxLength: 32 - lbaas_listeners: - type: "array" - description: "Specifies information about an enhanced load balancer. The system supports the binding of up to six load balancers. . For how to obtain information about an enhanced load balancer, see Querying Backend Server Groups." - items: - $ref: "#/definitions/LbaasListeners" - health_periodic_audit_method: - type: "string" - description: "Specifies the health check method for instances in the AS group. The health check methods include ELB_AUDIT and NOVA_AUDIT. When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.ELB_AUDIT: indicates the ELB health check, which takes effect in an AS group with a listener.NOVA_AUDIT: indicates the ECS health check, which is the health check method delivered with AS." - enum: - - "ELB_AUDIT" - - "NOVA_AUDIT" - health_periodic_audit_time: - type: "integer" - format: "int32" - description: "Specifies the health check period for the instances in the AS group. The value can be 1, 5, 15, 60, or 180 in the unit of minutes.If the value is set to 0, health check is performed every 10 seconds." - health_periodic_audit_grace_period: - type: "integer" - format: "int32" - description: "Specifies the grace period for instance health check. The unit is second and value range is 0-86400. The default value is 600.The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking the instance status only after the grace period ends.This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT." - maximum: 86400 - instance_terminate_policy: - type: "string" - description: "Specifies the instance removal policy.OLD_CONFIG_OLD_INSTANCE (default): The earlier-created instances based on the earlier-created AS configurations are removed first.OLD_CONFIG_NEW_INSTANCE: The later-created instances based on the earlier-created AS configurations are removed first.OLD_INSTANCE: The earlier-created instances are removed first.NEW_INSTANCE: The later-created instances are removed first." - enum: - - "OLD_CONFIG_OLD_INSTANCE" - - "OLD_CONFIG_NEW_INSTANCE" - - "OLD_INSTANCE" - - "NEW_INSTANCE" - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS configurations." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - notifications: - x-inner: true - type: "array" - description: "Specifies the notification mode.EMAIL refers to notification by email.This notification mode has been canceled. You are advised to configure the notification function for the AS group. For details, see Notifications." - items: - type: "string" - delete_publicip: - type: "boolean" - description: "Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, set this parameter to false. Then, the system only unbinds the EIP from the ECS and reserves the EIP.true: deletes the EIP bound to the ECS when deleting the ECS. If the EIP is billed on a yearly/monthly basis, it will not be deleted when the ECS is deleted.false: only unbinds the EIP bound to the ECS when deleting the ECS." - delete_volume: - type: "boolean" - description: "Specifies whether to delete the data disks attached to the ECS when deleting the ECS. The value can be true or false. The default value is false.true: deletes the data disks attached to the ECS when deleting the ECS. If the data disks are billed a yearly/monthly basis, they will not be deleted when the ECS is deleted.false: only detaches the data disks attached to the ECS when deleting the ECS." - enterprise_project_id: - type: "string" - description: "Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.If the value is 0 or left blank, the AS group belongs to the default enterprise project.If the value is a UUID, the AS group belongs to the enterprise project corresponding to the UUID.. For how to obtain an enterprise project ID, see Querying Enterprise Projects(https://support.huaweicloud.com/intl/en-us/api-em/en-us_topic_0121230880.html).If an enterprise project is configured for an AS group, ECSs created in this AS group also belong to this enterprise project. Otherwise, the default enterprise project will be used.NOTE:For details about enterprise project features, see Enterprise Project Management Service(https://support.huaweicloud.com/intl/en-us/usermanual-em/en-us_topic_0131965280.html)." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - multi_az_priority_policy: - type: "string" - description: "Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.EQUILIBRIUM_DISTRIBUTE (default): When adjusting the number of instances, ensure that instances in each AZ in the available_zones list is evenly distributed. If instances cannot be added in the target AZ, select another AZ based on the PICK_FIRST policy.PICK_FIRST: When adjusting the number of instances, target AZs are determined in the order in the available_zones list." - iam_agency_name: - type: "string" - description: "Specifies the agency name, in 1 to 64 characters.If iam_agency_name is set to null, you do not need to modify it.If iam_agency_name is left blank or has a value, you need to modify it." - description: - type: "string" - description: "Specifies the description of the AS group. The value can contain 1 to 256 characters." - description: "Request parameters" - ResumeScalingGroupOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies a flag for enabling or disabling an AS group. - - resume: enables the AS group. - pause: disables the AS group. - enum: - - "resume" - description: "Request parameters" - PauseScalingGroupOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies a flag for enabling or disabling an AS group. - - resume: enables the AS group. - pause: disables the AS group. - enum: - - "pause" - description: "Request parameters" - AllowedAddressPair: - type: "object" - properties: - ip_address: - type: "string" - description: "Specifies whether to allow the system to check the source and destination addresses.This function is enabled by default. This parameter cannot be left empty.To disable this function, set the value to 1.1.1.1/0.To enable this function, set a value other than 1.1.1.1/0." - description: "allowed_address_pairs field description" - CreateScalingPolicyOption: - type: "object" - required: - - "scaling_group_id" - - "scaling_policy_name" - - "scaling_policy_type" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_group_id: - type: "string" - description: "Specifies the AS group ID, which can be obtained using the API for querying AS groups." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - alarm_id: - type: "string" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you create an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV1" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default." - maximum: 86400 - description: "Request parameters" - ScalingPolicyActionV1: - type: "object" - properties: - operation: - type: "string" - example: "ADD" - description: "Specifies the operation to be performed. The default operation is ADD.ADD: adds specified number of instances to the AS group.REMOVE/REDUCE: removes or reduces specified number of instances from the AS group.SET: sets the number of instances in the AS group." - enum: - - "ADD" - - "REMOVE" - - "REDUCE" - - "SET" - instance_number: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the number of instances to be operated. The default number is 1. The value range is as follows for a default quota:If operation is set to SET, the value ranges from 0 to 300.If operation is set to ADD, REMOVE, or REDUCE, the value ranges from 1 to 300.NOTE:Either instance_number or instance_percentage is required." - instance_percentage: - type: "integer" - description: "Specifies the percentage of instances to be operated. You can increase, decrease, or set the number of instances in an AS group to the specified percentage of the current number of instances. If operation is set to ADD, REMOVE or REDUCE, the value is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.If neither instance_number nor instance_percentage is specified, the number of instances to be operated is 1.Either instance_number or instance_percentage is required." - minimum: 0 - maximum: 100 - description: "scaling_policy_action field description" - ScalingPolicyId: - type: "object" - properties: - scaling_policy_id: - type: "string" - example: "0h327883-324n-4dzd-9c61-68d03ee191dd" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - UpdateScalingPolicyOption: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - alarm_id: - type: "string" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you modify an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV1" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400." - maximum: 86400 - description: "Request parameters" - ScheduledPolicy: - type: "object" - required: - - "launch_time" - properties: - launch_time: - type: "string" - description: "Specifies the time when the scaling action is triggered. The time format complies with UTC.If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.If scaling_policy_type is set to RECURRENCE, the time format is hh:mm." - recurrence_type: - type: "string" - description: "Specifies the periodic triggering type. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.Daily: indicates that the scaling action is triggered once a day.Weekly: indicates that the scaling action is triggered once a week.Monthly: indicates that the scaling action is triggered once a month." - enum: - - "Daily" - - "Weekly" - - "Monthly" - recurrence_value: - type: "string" - description: "Specifies the day when a periodic scaling action is triggered. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.NOTE:When recurrence_type is set to Daily, this parameter does not take effect." - minLength: 1 - maxLength: 64 - start_time: - type: "string" - description: "Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The default value is the local time.The time format is YYYY-MM-DDThh:mmZ." - end_time: - type: "string" - description: "Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. This parameter is mandatory when scaling_policy_type is set to RECURRENCE. When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time.The time format is YYYY-MM-DDThh:mmZ." - description: "scheduled_policy field description" - ScalingV1Policy: - type: "object" - properties: - scaling_policy: - description: "Specifies details about the AS policy." - $ref: "#/definitions/ScalingV1PolicyDetail" - description: "Response parameters" - ScalingV1Policies: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_policies: - type: "array" - description: "Specifies scaling policies." - items: - $ref: "#/definitions/ScalingV1PolicyDetail" - description: "Response parameters" - ScalingV1PolicyDetail: - type: "object" - properties: - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV1" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - description: "scaling_policies field description" - BatchResumeScalingPoliciesOption: - type: "object" - required: - - "action" - - "scaling_policy_id" - properties: - scaling_policy_id: - type: "array" - description: "Specifies the AS policy ID." - items: - type: "string" - force_delete: - type: "string" - description: "Specifies whether to forcibly delete an AS policy. If the value is set to no, in-progress AS policies cannot be deleted. Options:no (default): indicates that the AS policy is not forcibly deleted.yes: indicates that the AS policy is forcibly deleted.This parameter is available only when action is set to delete." - enum: - - "no" - - "yes" - action: - type: "string" - description: "Specifies an action to be performed on AS policies in batches. The options are as follows:delete: deletes AS policies.resume: enables AS policies.pause: disables AS policies." - enum: - - "resume" - delete_alarm: - type: "string" - description: "Specifies whether to delete the alarm rule used by the alarm policy. The value can be yes or no (default).This parameter is available only when action is set to delete." - description: "Request parameters" - BatchDeleteScalingPoliciesOption: - type: "object" - required: - - "action" - - "scaling_policy_id" - properties: - scaling_policy_id: - type: "array" - description: "Specifies the AS policy ID." - items: - type: "string" - force_delete: - type: "string" - description: "Specifies whether to forcibly delete an AS policy. If the value is set to no, in-progress AS policies cannot be deleted. Options:no (default): indicates that the AS policy is not forcibly deleted.yes: indicates that the AS policy is forcibly deleted.This parameter is available only when action is set to delete." - enum: - - "no" - - "yes" - action: - type: "string" - description: "Specifies an action to be performed on AS policies in batches. The options are as follows:delete: deletes AS policies.resume: enables AS policies.pause: disables AS policies." - enum: - - "delete" - delete_alarm: - type: "string" - description: "Specifies whether to delete the alarm rule used by the alarm policy. The value can be yes or no (default).This parameter is available only when action is set to delete." - description: "Request parameters" - BatchPauseScalingPoliciesOption: - type: "object" - required: - - "action" - - "scaling_policy_id" - properties: - scaling_policy_id: - type: "array" - description: "Specifies the AS policy ID." - items: - type: "string" - force_delete: - type: "string" - description: "Specifies whether to forcibly delete an AS policy. If the value is set to no, in-progress AS policies cannot be deleted. Options:no (default): indicates that the AS policy is not forcibly deleted.yes: indicates that the AS policy is forcibly deleted.This parameter is available only when action is set to delete." - enum: - - "no" - - "yes" - action: - type: "string" - description: "Specifies an action to be performed on AS policies in batches. The options are as follows:delete: deletes AS policies.resume: enables AS policies.pause: disables AS policies." - enum: - - "pause" - delete_alarm: - type: "string" - description: "Specifies whether to delete the alarm rule used by the alarm policy. The value can be yes or no (default).This parameter is available only when action is set to delete." - description: "Request parameters" - ExecuteScalingPolicyOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies the operation for an AS policy. - - execute: immediately executes the AS policy. - resume: enables the AS group. - pause: disables the AS group. - enum: - - "execute" - description: "Request parameters" - ResumeScalingPolicyOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies the operation for an AS policy. - - execute: immediately executes the AS policy. - resume: enables the AS group. - pause: disables the AS group. - enum: - - "resume" - description: "Request parameters" - PauseScalingPolicyOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies the operation for an AS policy. - - execute: immediately executes the AS policy. - resume: enables the AS group. - pause: disables the AS group. - enum: - - "pause" - description: "Request parameters" - CreateScalingPolicyV2Option: - type: "object" - required: - - "scaling_policy_name" - - "scaling_policy_type" - - "scaling_resource_id" - - "scaling_resource_type" - properties: - scaling_policy_name: - type: "string" - example: "hth_aspolicy_1" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_resource_id: - type: "string" - example: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - description: "Specifies the scaling resource ID, which is the unique ID of an AS group or bandwidth.If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the unique AS group ID.If scaling_resource_type is set to BANDWIDTH, this parameter indicates the unique bandwidth ID.NOTE:AS cannot scale yearly/monthly bandwidths." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - example: "BANDWIDTH" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - scaling_policy_type: - type: "string" - example: "ALARM" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically.INTERVAL_ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by a refined scaling policy." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - example: "al1513822380493GvlJKZwA8" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you create an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - description: "Specifies the scaling actiong of the AS interval alarm." - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - example: 900 - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default." - maximum: 86400 - description: - type: "string" - description: "Specifies the description of the AS policy. The value can contain 1 to 256 characters." - description: "Request parameters" - ScalingPolicyActionV2: - type: "object" - properties: - operation: - type: "string" - example: "ADD" - description: "Specifies the operation to be performed. The default operation is ADD.If scaling_resource_type is set to SCALING_GROUP, the following operations are supported:ADD: indicates adding instances.REMOVE/REDUCE: indicates removing or reducing instances.SET: indicates setting the number of instances to a specified value.If scaling_resource_type is set to BANDWIDTH, the following operations are supported:ADD: indicates adding instances.REDUCE: indicates reducing instances.SET: indicates setting the number of instances to a specified value." - enum: - - "ADD" - - "REMOVE" - - "REDUCE" - - "SET" - size: - type: "integer" - example: 1 - description: "Specifies the operation size. The value is an integer from 0 to 300. The default value is 1. This parameter can be set to 0 only when operation is set to SET.If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the number of instances. The value is an integer from 0 to 300 and the default value is 1.If scaling_resource_type is set to BANDWIDTH, this parameter indicates the bandwidth (Mbit/s). The value is an integer from 1 to 300 and the default value is 1.If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set." - minimum: 0 - maximum: 300 - percentage: - type: "integer" - description: "Specifies the percentage of instances to be operated. If operation is set to ADD, REMOVE, or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. If neither size nor percentage is set, the default value of size is 1.If scaling_resource_type is set to BANDWIDTH, percentage is unavailable." - minimum: 0 - maximum: 20000 - limits: - type: "integer" - format: "int32" - example: 10 - description: "Specifies the operation restrictions.If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.If operation is set to ADD, this parameter indicates the maximum bandwidth allowed.If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed." - description: "scaling_policy_action field description" - UpdateScalingV2PolicyOption: - type: "object" - properties: - scaling_policy_name: - type: "string" - example: "hth_aspolicy_1\"" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_resource_id: - type: "string" - example: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - description: "Specifies the scaling resource ID, which is the ID of a unique AS group or bandwidth." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - example: "BANDWIDTH" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - scaling_policy_type: - type: "string" - example: "ALARM" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you modify an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - description: "Specifies the scaling actiong of the AS interval alarm." - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - example: 900 - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400." - maximum: 86400 - description: - type: "string" - description: "Specifies the description of the AS policy. The value can contain 1 to 256 characters." - description: "Request parameters" - ScalingV2Policy: - type: "object" - properties: - scaling_policy: - description: "Specifies details about the AS policy." - $ref: "#/definitions/ScalingV2PolicyDetail" - description: "Response parameters" - ScalingV2PolicyDetail: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - enum: - - "INSERVICE" - - "PAUSED" - - "EXECUTING" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - scheduled_policy: - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - meta_data: - description: "Provides additional information." - $ref: "#/definitions/ScalingPolicyV2MetaData" - description: - type: "string" - description: "Specifies the AS policy description." - description: "scaling_policy field description" - QueryScalingPolicyListV2Response: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 3 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_policies: - type: "array" - description: "Specifies AS policies." - items: - $ref: "#/definitions/ScalingPoliciesV2" - description: "Response parameters" - ScalingPoliciesV2: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - enum: - - "INSERVICE" - - "PAUSED" - - "EXECUTING" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - description: "Specifies the scaling actiong of the AS interval alarm." - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - meta_data: - description: "Provides additional information." - $ref: "#/definitions/ScalingPolicyV2MetaData" - description: - type: "string" - description: "Specifies the AS policy description." - description: "scaling_policies field description" - AllScalingPolicies: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 3 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_policies: - type: "array" - description: "Specifies AS policies." - items: - $ref: "#/definitions/ScalingAllPolicyDetail" - description: "Response parameters" - ScalingAllPolicyDetail: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - enum: - - "INSERVICE" - - "PAUSED" - - "EXECUTING" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - minLength: 1 - maxLength: 64 - scheduled_policy: - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - meta_data: - description: "Provides additional information." - $ref: "#/definitions/ScalingPolicyV2MetaData" - description: - type: "string" - description: "Specifies the AS policy description." - description: "scaling_policies field description" - ScalingPolicyV2MetaData: - type: "object" - properties: - metadata_bandwidth_share_type: - type: "string" - description: "Specifies the bandwidth sharing type in the bandwidth scaling policy." - metadata_eip_id: - type: "string" - description: "Specifies the EIP ID for the bandwidth in the bandwidth scaling policy." - metadata_eip_address: - type: "string" - description: "Specifies the EIP for the bandwidth in the bandwidth scaling policy." - description: "meta_data field description" - IntervalAlarmActionsV2: - type: "object" - properties: - operation: - type: "string" - example: "ADD" - description: |- - Specifies the operation to be performed. The default operation is ADD. - If scaling_resource_type is set to SCALING_GROUP, the following operations are supported: - ADD: indicates adding instances. - REMOVE/REDUCE: indicates removing or reducing instances. - SET: indicates setting the number of instances to a specified value. - If scaling_resource_type is set to BANDWIDTH, the following operations are supported: - ADD: indicates adding instances. - REDUCE: indicates reducing instances. - SET: indicates setting the number of instances to a specified value. - enum: - - "ADD" - - "REMOVE" - - "REDUCE" - - "SET" - limits: - type: "integer" - format: "int32" - example: 10 - description: |- - Specifies the operation restrictions. - - If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s. - - If operation is set to ADD, this parameter indicates the maximum bandwidth allowed. - If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed. - size: - type: "integer" - format: "int32" - example: 1 - description: |- - Specifies the operation size. The value is an integer from 0 to 300. The default value is 1. This parameter can be set to 0 only when operation is set to SET. - - If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the number of instances. The value is an integer from 0 to 300 and the default value is 1. - If scaling_resource_type is set to BANDWIDTH, this parameter indicates the bandwidth (Mbit/s). The value is an integer from 1 to 300 and the default value is 1. - If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. - minimum: 0 - maximum: 300 - lower_bound: - type: "number" - format: "double" - upper_bound: - type: "number" - format: "double" - percentage: - type: "integer" - format: "int32" - description: "Specifies the percentage of instances to be operated. If operation is set to ADD, REMOVE, or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000. If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. If neither size nor percentage is set, the default value of size is 1. If scaling_resource_type is set to BANDWIDTH, percentage is unavailable." - description: "Operation alarm Interval" - PolicyExecuteLogs: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the total number of query records." - minimum: 0 - maximum: 32768 - start_number: - type: "integer" - example: 0 - description: "Specifies the start line number." - minimum: 0 - maximum: 32768 - limit: - type: "integer" - example: 10 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 32768 - scaling_policy_execute_log: - type: "array" - description: "Specifies the AS policy execution logs." - items: - $ref: "#/definitions/ScalingPolicyExecuteLogList" - description: "Response parameters" - ScalingPolicyExecuteLogList: - type: "object" - properties: - status: - type: "string" - description: |- - Specifies the AS policy execution status. - - SUCCESS: The AS policy has been executed. - FAIL: Executing the AS policy failed. - EXECUTING: The AS policy is being executed. - enum: - - "SUCCESS" - - "FAIL" - - "EXECUTING" - failed_reason: - type: "string" - description: "Specifies the AS policy execution failure." - execute_type: - type: "string" - description: |- - Specifies the AS policy execution type. - - SCHEDULED: automatically triggered at a specified time point - RECURRENCE: automatically triggered at a specified time period - ALARM: alarm-triggered - MANUAL: manually triggered - INTERVAL_ALARM: automatically triggered by a refined scaling policy - enum: - - "SCHEDULE" - - "RECURRENCE" - - "ALARM" - - "MANUAL" - execute_time: - type: "string" - description: "Specifies the time when an AS policy was executed. The time format complies with UTC." - id: - type: "string" - description: "Specifies the ID of an AS policy execution log." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenant_id: - type: "string" - description: "Specifies the project ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - old_value: - type: "string" - description: "Specifies the source value." - desire_value: - type: "string" - description: "Specifies the target value." - limit_value: - type: "string" - description: "Specifies the operation restrictions.If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.In this case:If operation is set to ADD, this parameter indicates the maximum bandwidth allowed.If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed." - type: - type: "string" - description: |- - Specifies the AS policy execution type. - - ADD: indicates adding instances. - REMOVE: indicates reducing instances. - SET: indicates setting the number of instances to a specified value. - enum: - - "ADD" - - "REMOVE" - - "SET" - job_records: - type: "array" - description: "Specifies the tasks contained in a scaling action based on an AS policy." - items: - $ref: "#/definitions/JobRecords" - meta_data: - description: "Provides additional information." - $ref: "#/definitions/EipMetaData" - description: "scaling_policy_execute_log field description" - JobRecords: - type: "object" - properties: - job_name: - type: "string" - description: "Specifies the task name." - record_type: - type: "string" - description: |- - Specifies the record type. - - API: API calling type - MEG: message type - enum: - - "API" - - "MEG" - record_time: - type: "string" - description: "Specifies the record time." - request: - type: "string" - description: "Specifies the request body. This parameter is valid only if record_type is set to API." - response: - type: "string" - description: "Specifies the response body. This parameter is valid only if record_type is set to API." - code: - type: "string" - description: "Specifies the returned code. This parameter is valid only if record_type is set to API." - message: - type: "string" - description: "Specifies the message. This parameter is valid only if record_type is set to MEG." - job_status: - type: "string" - description: |- - Specifies the execution status of the task. - - SUCCESS: The task is successfully executed. - FAIL: The task failed to be executed. - enum: - - "SUCCESS" - - "FAIL" - description: "job_records field description" - EipMetaData: - type: "object" - properties: - metadata_bandwidth_share_type: - type: "string" - description: "Specifies the bandwidth sharing type in the bandwidth scaling policy." - metadata_eip_id: - type: "string" - description: "Specifies the EIP ID for the bandwidth in the bandwidth scaling policy." - metadataeip_address: - type: "string" - description: "Specifies the EIP for the bandwidth in the bandwidth scaling policy." - description: "meta_data field description" - ScalingInstances: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 2 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - format: "int32" - example: 20 - description: "Specifies the maximum number of resources to be queried." - scaling_group_instances: - type: "array" - description: "Specifies details about the instances in the AS group." - items: - $ref: "#/definitions/ScalingGroupInstance" - description: "Response parameters" - ScalingGroupInstance: - type: "object" - properties: - instance_id: - type: "string" - description: "Specifies the instance ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - instance_name: - type: "string" - description: "Specifies the instance name." - minLength: 1 - maxLength: 64 - scaling_group_id: - type: "string" - description: "Specifies the ID of the AS group to which the instance belongs." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_name: - type: "string" - description: |- - Specifies the name of the AS group to which the instance belongs. - - Supports fuzzy search. - life_cycle_state: - type: "string" - description: "Specifies the instance lifecycle status in the AS group.INSERVICE: The instance is enabled.PENDING: The instance is being added to the AS group.PENDING_WAIT: The instance is waiting to be added to the AS group.REMOVING: The instance is being removed from the AS group.REMOVING_WAIT: The instance is waiting to be removed from the AS group.STANDBY: The instance is in standby state.ENTERING_STANDBY: The instance is entering the standby state." - enum: - - "INSERVICE" - - "PENDING" - - "REMOVING" - - "PENDING_WAIT" - - "REMOVING_WAIT" - health_status: - type: "string" - description: |- - Specifies the instance health status. - - INITIALIZING: The instance is being initialized. - NORMAL: The instance is functional. - ERROR: The instance is faulty. - enum: - - "NORMAL" - - "ERROR" - - "INITAILIZING" - scaling_configuration_name: - type: "string" - description: "Specifies the AS configuration name." - minLength: 1 - maxLength: 64 - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID.If the returned value is not empty, the instance is an ECS automatically created in a scaling action.If the returned value is empty, the instance is an ECS manually added to the AS group." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when the instance is added to the AS group. The time format complies with UTC." - protect_from_scaling_down: - type: "boolean" - description: "Specifies the instance protection status." - description: "scaling_group_instances field description" - BatchAddInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "ADD" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchRemoveInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "REMOVE" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchProtectInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "PROTECT" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchUnprotectInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "UNPROTECT" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchEnterStandbyInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "ENTER_STANDBY" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchExitStandByInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "EXIT_STANDBY" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - CreateLifeCycleHookOption: - type: "object" - required: - - "lifecycle_hook_name" - - "lifecycle_hook_type" - - "notification_topic_urn" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 32 characters." - minLength: 1 - maxLength: 64 - lifecycle_hook_type: - type: "string" - description: "Specifies the lifecycle hook type. Options:INSTANCE_TERMINATING: The hook suspends the instance when the instance is terminated.INSTANCE_LAUNCHING: The hook suspends the instance when the instance is started." - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - description: "Specifies the default lifecycle hook callback operation. By default, this operation is performed when the timeout duration expires.ABANDONCONTINUENOTE:If an instance is starting, CONTINUE indicates that your customized operations are successful and the instance can be used. ABANDON indicates that your customized operations failed, and the instance will be terminated. In such a case, the scaling action fails, and you must create a new instance.If an instance is stopping, both ABANDON and CONTINUE allow instance termination. The difference between the two states is as follows: ABANDON stops other lifecycle hooks, but CONTINUE allows the completion of other lifecycle hooks.The default value of this parameter is ABANDON." - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration, which ranges from 60 to 86400 in the unit of second. The default value is 3600.By default, this parameter specifies the instance waiting duration. You can prolong the timeout duration or perform the CONTINUE or ABANDON operation before the timeout duration expires." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN.This parameter specifies a notification object for a lifecycle hook. When an instance is suspended by the lifecycle hook, the SMN service sends a notification to the object. This notification contains the basic instance information, your customized notification content, and the token for controlling lifecycle operations." - notification_metadata: - type: "string" - description: "Specifies a customized notification, which contains no more than 256 characters in length. The message cannot contain the following characters: <>&'()After a notification object is configured, the SMN service sends your customized notification to the object." - description: "Request parameters" - LifeCycleHookResult: - type: "object" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name." - minLength: 1 - maxLength: 64 - lifecycle_hook_type: - type: "string" - description: |- - Specifies the lifecycle hook type. - - INSTANCE_TERMINATING - INSTANCE_LAUNCHING - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - description: |- - Specifies the default lifecycle hook callback operation. - - ABANDON - CONTINUE - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration in the unit of second." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - notification_topic_name: - type: "string" - description: "Specifies the topic name in SMN." - minLength: 1 - maxLength: 64 - notification_metadata: - type: "string" - description: "Specifies the notification message." - create_time: - type: "string" - description: "Specifies the UTC-compliant time when the lifecycle hook is created." - description: "Response parameters" - QueryLifecycleHookListResult: - type: "object" - properties: - lifecycle_hooks: - type: "array" - description: "Specifies lifecycle hooks." - items: - $ref: "#/definitions/LifecycleHookList" - description: "Response parameters" - LifecycleHookList: - type: "object" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name." - minLength: 1 - maxLength: 64 - lifecycle_hook_type: - type: "string" - description: |- - Specifies the lifecycle hook type. - - INSTANCE_TERMINATING - INSTANCE_LAUNCHING - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - description: |- - Specifies the default lifecycle hook callback operation. - - ABANDON - CONTINUE - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration in the unit of second." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - notification_topic_name: - type: "string" - description: "Specifies the topic name in SMN." - minLength: 1 - maxLength: 64 - notification_metadata: - type: "string" - description: "Specifies the customized notification." - create_time: - type: "string" - description: "Specifies the time when the lifecycle hook is created. The time is UTC-compliant." - description: "lifecycle_hooks field description" - UpdateLifeCycleHookOption: - type: "object" - properties: - lifecycle_hook_type: - type: "string" - description: "Specifies the lifecycle hook type. Options:INSTANCE_TERMINATING: The hook suspends the instance when the instance is terminated.INSTANCE_LAUNCHING: The hook suspends the instance when the instance is started." - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - example: "CONTINUE" - description: "Specifies the default lifecycle hook callback operation. By default, this operation is performed when the timeout duration expires.ABANDONCONTINUENOTE:If an instance is starting, CONTINUE indicates that your customized operations are successful and the instance can be used. ABANDON indicates that your customized operations failed, and the instance will be terminated. In such a case, the scaling action fails, and you must create a new instance.If an instance is stopping, both ABANDON and CONTINUE allow instance termination. The difference between the two states is as follows: ABANDON stops other lifecycle hooks, but CONTINUE allows the completion of other lifecycle hooks.The default value of this parameter is ABANDON." - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration, which ranges from 60 to 86400 in the unit of second. The default value is 3600.By default, this parameter specifies the instance waiting duration. You can prolong the timeout duration or perform the CONTINUE or ABANDON operation before the timeout duration expires." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN.This parameter specifies a notification object for a lifecycle hook. When an instance is suspended by the lifecycle hook, the SMN service sends a notification to the object. This notification contains the basic instance information, your customized notification content, and the token for controlling lifecycle operations." - notification_metadata: - type: "string" - description: "Specifies a customized notification, which contains no more than 256 characters in length. The message cannot contain the following characters: <>&'()After a notification object is configured, the SMN service sends your customized notification to the object." - description: "Modifying a Lifecycle Hook" - CallbackLifeCycleHookOption: - type: "object" - required: - - "lifecycle_action_result" - properties: - lifecycle_action_key: - type: "string" - example: "23880867-6288-4470-98a8-f8bda096b6c4" - description: "Specifies the lifecycle operation token, which is obtained by calling the API for querying instance suspension.When specifying a lifecycle callback object, this field is mandatory if the instance_id parameter is not used. If both this parameter and the instance_id parameter are used, preferentially use this parameter for callback." - instance_id: - type: "string" - description: "Specifies the instance ID.When a lifecycle callback object is specified, this parameter is mandatory if the lifecycle_action_key parameter is not used." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name.When a lifecycle callback object is specified, this parameter is mandatory if the lifecycle_action_key parameter is not used." - minLength: 1 - maxLength: 64 - lifecycle_action_result: - type: "string" - description: |- - Specifies the lifecycle callback action. - - ABANDON: terminates the instance. - CONTINUE: continues the instance. - EXTEND: extends the timeout duration, one hour each time. - enum: - - "ABANDON" - - "CONTINUE" - - "EXTEND" - description: "Request parameters" - InstanceListResult: - type: "object" - properties: - instance_hanging_info: - type: "array" - description: "Specifies lifecycle hook information about an AS instance." - items: - $ref: "#/definitions/InstanceHangingInfos" - description: "Response parameters" - InstanceHangingInfos: - type: "object" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name." - minLength: 1 - maxLength: 64 - lifecycle_action_key: - type: "string" - description: "Specifies the lifecycle action key, which determines the lifecycle callback object." - instance_id: - type: "string" - description: "Specifies the AS instance ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - lifecycle_hook_status: - type: "string" - description: |- - Specifies the lifecycle hook status. - - HANGING: suspends the instance. - CONTINUE: continues the instance. - ABANDON: terminates the instance. - enum: - - "HANGING" - - "CONTINUE" - - "ABANDON" - timeout: - type: "string" - description: "Specifies the timeout duration in the format of \"YYYY-MM-DDThh:mm:ssZ\". The time is UTC-compliant." - default_result: - type: "string" - description: "Specifies the default lifecycle hook callback operation." - description: "instance_hanging_info field description" - CreateNotificationOption: - required: - - "topic_scene" - - "topic_urn" - properties: - topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - topic_scene: - type: "array" - description: "Specifies a notification scenario, which can be one of the following: SCALING_UP£ºindicates that the capacity is expanded. SCALING_UP_FAIL£ºindicates that the capacity expansion failed. SCALING_DOWN£ºindicates that the capacity is reduced. SCALING_DOWN_FAIL£ºindicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL£ºindicates that an exception has occurred in the AS group." - items: - type: "string" - enum: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - description: "Notifications" - CreateNotificationResult: - type: "object" - properties: - topic_urn: - type: "string" - example: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - description: "Specifies a unique topic in SMN." - topic_scene: - type: "array" - example: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - description: "Specifies a notification scenario, which can be one of the following: SCALING_UP£ºindicates that the capacity is expanded. SCALING_UP_FAIL£ºindicates that the capacity expansion failed. SCALING_DOWN£ºindicates that the capacity is reduced. SCALING_DOWN_FAIL£ºindicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL£ºindicates that an exception has occurred in the AS group." - items: - type: "string" - topic_name: - type: "string" - example: "gsh" - description: "Specifies the topic name in SMN." - description: "Response parameters" - ListScalingNotificationsResult: - type: "object" - properties: - topics: - type: "array" - description: "Specifies the AS group notification list." - items: - $ref: "#/definitions/Topics" - description: "Response parameters" - Topics: - properties: - topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - topic_scene: - type: "array" - description: "Specifies a notification scenario, which can be one of the following: SCALING_UP£ºindicates that the capacity is expanded. SCALING_UP_FAIL£ºindicates that the capacity expansion failed. SCALING_DOWN£ºindicates that the capacity is reduced. SCALING_DOWN_FAIL£ºindicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL£ºindicates that an exception has occurred in the AS group." - items: - type: "string" - topic_name: - type: "string" - description: "Specifies the topic name in SMN." - QuotaResult: - type: "object" - properties: - quotas: - description: "Specifies quota details." - $ref: "#/definitions/AllQuotas" - description: "Response parameters" - AllQuotas: - type: "object" - properties: - resources: - type: "array" - description: "Specifies resources." - items: - $ref: "#/definitions/AllResources" - description: "Response parameters" - AllResources: - type: "object" - properties: - type: - type: "string" - description: |- - Specifies the quota type. - - scaling_Group: AS group quota - scaling_Config: AS configuration quota - scaling_Policy: AS policy quota - scaling_Instance: instance quota - bandwidth_scaling_policy: bandwidth scaling policy quota - enum: - - "scaling_group" - - "scaling_config" - - "scaling_Policy" - - "scaling_Instance" - - "bandwidth_scaling_policy" - used: - type: "integer" - format: "int32" - description: "Specifies the used amount of the quota.When type is set to scaling_Policy or scaling_Instance, this parameter is reserved, and the system returns -1 as the parameter value. You can query the used quota of AS policies and AS instances in a specified AS group." - quota: - type: "integer" - format: "int32" - description: "Specifies the total quota." - max: - type: "integer" - format: "int32" - description: "Specifies the quota upper limit." - min: - type: "integer" - format: "int32" - description: "Specifies the quota lower limit." - description: "resources field description" - PolicyInstanceQuotaResult: - type: "object" - properties: - quotas: - description: "Specifies quota details." - $ref: "#/definitions/PolicyInstanceQuotas" - description: "Response parameters" - PolicyInstanceQuotas: - type: "object" - properties: - resources: - type: "array" - description: "Specifies resources." - items: - $ref: "#/definitions/PolicyInstanceResources" - description: "quotas field description" - PolicyInstanceResources: - type: "object" - properties: - type: - type: "string" - description: |- - Specifies the quota type. - - scaling_Policy: indicates AS policies. - scaling_Instance: indicates instances. - used: - type: "integer" - format: "int32" - description: "Specifies the used quota." - quota: - type: "integer" - format: "int32" - description: "Specifies the total quota." - max: - type: "integer" - format: "int32" - description: "Specifies the quota upper limit." - min: - type: "integer" - format: "int32" - description: "Specifies the quota lower limit." - description: "resources field description" - ScalingActivityLogs: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 2 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_activity_log: - type: "array" - description: "Specifies scaling action logs." - items: - $ref: "#/definitions/ScalingActivityLogList" - description: "Response parameters" - ScalingActivityLogList: - type: "object" - properties: - status: - type: "string" - description: |- - Specifies the status of the scaling action. - - SUCCESS: The scaling action has been performed. - FAIL: Performing the scaling action failed. - DOING: The scaling action is being performed. - enum: - - "SUCCESS" - - "FAIL" - - "DOING" - start_time: - type: "string" - format: "date-time" - description: "Specifies the start time of the scaling action. The time format must comply with UTC." - end_time: - type: "string" - format: "date-time" - description: "Specifies the end time of the scaling action. The time format must comply with UTC." - id: - type: "string" - description: "Specifies the scaling action log ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - instance_removed_list: - type: "string" - description: "Specifies the names of the instances removed from the AS group after the scaling action is complete. The instance names are separated using commas (,)." - instance_deleted_list: - type: "string" - description: "Specifies the names of the instances removed and deleted from the AS group after the scaling action is complete. The instance names are separated using commas (,)." - instance_added_list: - type: "string" - description: "Specifies the names of the instances added to the AS group after the scaling action is complete. The instance names are separated using commas (,)." - scaling_value: - type: "integer" - format: "int32" - description: "Specifies the number of added or removed instances in the scaling action." - description: - type: "string" - description: "Specifies the description of the scaling action." - instance_value: - type: "integer" - format: "int32" - description: "Specifies the number of instances in the AS group." - desire_value: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances for the scaling action." - description: "scaling_activity_log field description" - ScalingActivityV2Logs: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 2 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "pecifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_activity_log: - type: "array" - description: "Specifies scaling action logs." - items: - $ref: "#/definitions/ScalingActivityLogV2" - description: "Response parameters" - ScalingActivityLogV2: - type: "object" - properties: - status: - type: "string" - description: |- - Specifies the status of the scaling action. - - SUCCESS: The scaling action has been performed. - FAIL: Performing the scaling action failed. - DOING: The scaling action is being performed. - enum: - - "SUCCESS" - - "FAIL" - - "DOING" - start_time: - type: "string" - format: "date-time" - description: "Specifies the start time of the scaling action. The time format must comply with UTC." - end_time: - type: "string" - format: "date-time" - description: "Specifies the end time of the scaling action. The time format must comply with UTC." - id: - type: "string" - description: "Specifies the scaling action log ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - instance_removed_list: - type: "array" - description: "Specifies names of the ECSs that are removed from the AS group in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - instance_deleted_list: - type: "array" - description: "Specifies names of the ECSs that are removed from the AS group and deleted in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - instance_added_list: - type: "array" - description: "Specifies names of the ECSs that are added to the AS group in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - instance_failed_list: - type: "array" - description: "Specifies the ECSs for which a scaling action fails." - items: - $ref: "#/definitions/ScalingInstance" - instance_standby_list: - type: "array" - description: "Specifies the ECSs that are set to standby mode or for which standby mode is canceled in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - scaling_value: - type: "integer" - format: "int32" - description: "Specifies the number of added or deleted instances during the scaling." - description: - type: "string" - description: "Specifies the description of the scaling action." - instance_value: - type: "integer" - format: "int32" - description: "Specifies the number of instances in the AS group." - desire_value: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances for the scaling action." - lb_bind_success_list: - type: "array" - description: "Specifies the load balancers that are bound to the AS group." - items: - $ref: "#/definitions/ModifyLb" - lb_bind_failed_list: - type: "array" - description: "Specifies the load balancers that failed to be bound to the AS group." - items: - $ref: "#/definitions/ModifyLb" - lb_unbind_success_list: - type: "array" - description: "Specifies the load balancers that are unbound from the AS group." - items: - $ref: "#/definitions/ModifyLb" - lb_unbind_failed_list: - type: "array" - description: "Specifies the load balancers that failed to be unbound from the AS group." - items: - $ref: "#/definitions/ModifyLb" - type: - type: "string" - description: "Specifies the type of the scaling action." - description: "scaling_activity_log field description" - ScalingInstance: - type: "object" - properties: - instance_name: - type: "string" - description: "Specifies the ECS name." - minLength: 1 - maxLength: 64 - instance_id: - type: "string" - description: "Specifies the ECS ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - failed_reason: - type: "string" - description: "Specifies the cause of the instance scaling failure." - failed_details: - type: "string" - description: "Specifies details of the instance scaling failure." - instance_config: - type: "string" - description: "Specifies the information about instance configurations." - description: "scaling_instance field description" - ModifyLb: - type: "object" - properties: - lbaas_listener: - description: "Specifies information about an enhanced load balancer." - $ref: "#/definitions/LbaasListener" - listener: - type: "string" - description: "Specifies information about a classic load balancer." - failed_reason: - type: "string" - description: "Specifies the cause of a load balancer migration failure." - failed_details: - type: "string" - description: "Specifies the details of a load balancer migration failure." - description: "modify_lb field description" - LbaasListener: - type: "object" - properties: - listener_id: - type: "string" - description: "Specifies the listener ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - pool_id: - type: "string" - description: "Specifies the backend ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - protocol_port: - type: "integer" - description: "Specifies the backend protocol port, which is the port on which a backend ECS listens for traffic." - minimum: 1 - maximum: 65535 - weight: - type: "integer" - format: "int32" - description: "Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener." - description: "lbaas_listener field description" - ShowTagByTenantResult: - type: "object" - properties: - tags: - type: "array" - description: "Specifies tags" - items: - $ref: "#/definitions/TagsMultiValue" - description: "Response parameters" - QueryTagByResourceIdResult: - type: "object" - properties: - tags: - type: "array" - description: "Specifies tags." - items: - $ref: "#/definitions/TagsSingleValue" - sys_tags: - type: "array" - description: "Specifies system tags." - items: - $ref: "#/definitions/TagsSingleValue" - description: "Response parameters" - TagsSingleValue: - type: "object" - required: - - "key" - properties: - key: - type: "string" - description: "Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left blank (This parameter is not verified in the search process.) A maximum of 10 keys are allowed and the key cannot be left blank or an empty string. Each key must be unique." - value: - type: "string" - description: "Specifies tag values. A value contains a maximum of 43 Unicode characters. A key contains a maximum of 10 values. Each value of the same key must be unique." - description: "ResourceTag field description" - QueryTagsOption: - type: "object" - required: - - "action" - properties: - tags: - type: "array" - example: - - key: "key1" - values: - - "*value1" - - "value2" - description: "Specifies filter criteria with tags included. A maximum of 10 keys can be contained. The structure body must be complete." - items: - $ref: "#/definitions/TagsMultiValue" - tags_any: - type: "array" - example: - - key: "key1" - values: - - "value1" - - "value2" - description: "Specifies filter criteria with any tag included. A maximum of 10 keys can be contained." - items: - $ref: "#/definitions/TagsMultiValue" - not_tags: - type: "array" - example: - - key: "key1" - values: - - "*value1" - - "value2" - description: "Specifies filter criteria without tags included. A maximum of 10 keys can be contained." - items: - $ref: "#/definitions/TagsMultiValue" - not_tags_any: - type: "array" - example: - - key: "key1" - values: - - "value1" - - "value2" - description: "Specifies filter criteria without any tag included. A maximum of 10 keys can be contained." - items: - $ref: "#/definitions/TagsMultiValue" - limit: - type: "string" - example: "100" - description: "Specifies the maximum number of query records. The maximum value is 1,000, and the minimum value is 1.If action is set to count, this parameter is invalid.If action is set to filter, the default value is 1000." - marker: - type: "string" - description: "Marks the paging location (index position). You are advised to use the offset parameter to set the index position.Marks the paging location (resource ID or index location)." - action: - type: "string" - description: "Specifies the operation, which can be filter or count.filter: indicates that resources are filtered by tag and the resources meeting the search criteria are returned on pages.count: indicates that resources are searched by tag and the number of resources meeting the search criteria is returned." - enum: - - "filter" - - "count" - offset: - type: "string" - description: "Specifies the index position. The query starts from the next image indexed by this parameter. The value must be a non-negative number.You do not need to specify this parameter when querying resources on the first page. When you query resources on subsequent pages, set offset to the location returned in the response body for the previous query.If the action value is count, this parameter is invalid.If the action value is filter, the default value is 0." - matches: - type: "array" - example: - - key: "resource_name" - values: "resource1" - description: "Specifies fuzzy search." - items: - $ref: "#/definitions/Matches" - description: "Request parameters" - TagsMultiValue: - type: "object" - required: - - "key" - - "values" - properties: - key: - type: "string" - description: "Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left blank (This parameter is not verified in the search process.) A maximum of 10 keys are allowed and the key cannot be left blank or an empty string. Each key must be unique." - minLength: 1 - maxLength: 127 - values: - type: "array" - description: "Specifies tag values. A value contains a maximum of 43 Unicode characters. A key contains a maximum of 10 values. Each value of the same key must be unique." - items: - type: "string" - minLength: 0 - maxLength: 255 - Matches: - type: "object" - required: - - "key" - - "value" - properties: - key: - type: "string" - description: |- - Specifies the key based on which to query resources. - - The parameter value can only be resource_name. - minLength: 1 - maxLength: 127 - value: - type: "string" - description: "Specifies the value. The value is a fixed dictionary value. A value contains a maximum of 255 Unicode characters. If the value is an empty string or resource_id, exact match is used." - minLength: 1 - maxLength: 255 - QueryTagsResult: - type: "object" - properties: - resources: - type: "array" - description: "Specifies tag resources." - items: - $ref: "#/definitions/Resources" - total_count: - type: "integer" - example: 2 - description: "Specifies the total number of records. When action is set to count, only this parameter is returned. The values of resources and marker are not returned." - marker: - type: "string" - example: "2" - description: "Specifies the paging location identifier." - Resources: - type: "object" - properties: - resource_id: - type: "string" - description: "Specifies the resource ID." - resource_detail: - type: "string" - description: "Specifies the resource details." - tags: - type: "array" - description: "Specifies tags. If there is no tag, tags is taken as an empty array by default." - items: - $ref: "#/definitions/ResourceTags" - resource_name: - type: "string" - description: "Specifies the resource name. If there is no resource, this parameter is an empty string by default." - ResourceTags: - type: "object" - properties: - key: - type: "string" - description: "Specifies the tag key. It contains a maximum of 36 Unicode characters." - value: - type: "string" - description: "Specifies the tag value. It contains a maximum of 36 Unicode characters." - CreateTagsOption: - type: "object" - required: - - "action" - - "tags" - properties: - tags: - type: "array" - description: "Specifies the tag list. If action is set to delete, the tag structure cannot be missing, and the key cannot be left blank or an empty string." - items: - $ref: "#/definitions/TagsSingleValue" - action: - type: "string" - description: "Specifies the operation ID. The value is case-sensitive and can be any of the following:delete: indicates deleting a tag.create: indicates creating a tag. If the same key value already exists, it will be overwritten." - enum: - - "create" - description: "Request parameters" - DeleteTagsOption: - type: "object" - required: - - "action" - - "tags" - properties: - tags: - type: "array" - description: "Specifies the tag list. If action is set to delete, the tag structure cannot be missing, and the key cannot be left blank or an empty string." - items: - $ref: "#/definitions/TagsSingleValue" - action: - type: "string" - description: "Specifies the operation ID. The value is case-sensitive and can be any of the following:delete: indicates deleting a tag.create: indicates creating a tag. If the same key value already exists, it will be overwritten." - enum: - - "delete" - description: "Request parameters" - CreateScheduledTaskOption: - type: "object" - required: - - "instance_number" - - "name" - - "scheduled_policy" - properties: - name: - type: "string" - description: "Specifies the AS scheduled task name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or point-in-time AS policy." - $ref: "#/definitions/ScheduledTaskPolicy" - instance_number: - description: "Specifies the max and min count of instance for AS group." - $ref: "#/definitions/IntegerRange" - description: "Request parameters" - IntegerRange: - type: "object" - properties: - max: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the maximum of instances for AS group. NOTE: At least one of the max and min is required. If both max and min are specified, the min value should be less than or equal to the max value." - min: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the minimum of instances for AS group. NOTE: At least one of the max and min is required. If both max and min are specified, the min value should be less than or equal to the max value." - desire: - type: "integer" - format: "int32" - description: "The max and min instance count of AS group." - ScheduledTaskId: - type: "object" - properties: - task_id: - type: "string" - example: "0h327883-324n-4dzd-9c61-68d03ee191dd" - description: "the AS scheduled task ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - UpdateScheduledTaskOption: - type: "object" - properties: - name: - type: "string" - description: "Specifies the AS scheduled task. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or point-in-time AS policy." - $ref: "#/definitions/ScheduledTaskPolicy" - instance_number: - description: "Specifies the max and min count of instance for AS group." - $ref: "#/definitions/IntegerRange" - description: "Request parameters" - ScheduledTaskPolicy: - type: "object" - required: - - "launch_time" - properties: - start_time: - type: "string" - description: "Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The default value is the local time. The time format is yyyy-MM-ddTHH:mmZ." - end_time: - type: "string" - description: "Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time. The time format is yyyy-MM-ddTHH:mmZ." - launch_time: - type: "string" - description: "Specifies the time when the scaling action is triggered. The time format complies with UTC. If recurrence_type is empty or null, the time format is yyyy-MM-ddTHH:mmZ. If recurrence_type is not empty, the time format is HH:mm." - recurrence_type: - type: "string" - description: "'Specifies the periodic triggering type. DAILY: indicates that the scaling action is triggered once a day. WEEKLY: indicates that the scaling action is triggered once a week. MONTHLY: indicates that the scaling action is triggered once a month.'" - enum: - - "DAILY" - - "WEEKLY" - - "MONTHLY" - recurrence_value: - type: "string" - description: "Specifies the day when a periodic scaling action is triggered. If recurrence_type is set to DAILY, the value is null, indicating that the scaling action is triggered once a day. If recurrence_type is set to WEEKLY, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5. If recurrence_type is set to MONTHLY, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28." - minLength: 1 - maxLength: 64 - description: "scheduled_policy field description" - PageInfo: - type: "object" - properties: - next_marker: - type: "string" - description: "Specifies the marker of next page." - minLength: 1 - maxLength: 64 - description: "page info" - ScheduledTasksResult: - type: "object" - properties: - page_info: - description: "Specifies the page info of the last record of query." - $ref: "#/definitions/PageInfo" - scheduled_tasks: - type: "array" - description: "Specifies scheduled tasks." - items: - $ref: "#/definitions/ScheduledTaskDetail" - description: "Response parameters" - ScheduledTaskDetail: - type: "object" - properties: - task_id: - type: "string" - description: "Specifies the AS scheduled task ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - name: - type: "string" - description: "Specifies the AS scheduled task name." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or point-in-time for task." - $ref: "#/definitions/ScheduledTaskPolicy" - instance_number: - description: "Specifies the max and min instance number for the AS group." - $ref: "#/definitions/IntegerRange" - create_time: - type: "string" - description: "Specifies the time when an AS scheduled task was created. The time format complies with UTC." - tenant_id: - type: "string" - domain_id: - type: "string" - update_time: - type: "string" - description: "scheduled task description" - PutWarmPoolOption: - type: "object" - properties: - min_capacity: - type: "integer" - format: "int32" - description: "The minimum capacity of the warm pool must be filled out simultaneously with the maximum capacity, or neither should be filled out. When filling out the minimum and maximum capacities of the warm pool, they must be equal." - max_capacity: - type: "integer" - format: "int32" - description: "The maximum capacity of the warm pool must be filled out, and the minimum and maximum capacities must either be filled out simultaneously or not at all. When filling out the minimum and maximum capacities of the warm pool, they must be equal." - instance_init_wait_time: - type: "integer" - format: "int32" - description: "Instance initialization waiting time, unit: seconds" - WarmPoolResult: - type: "object" - properties: - warm_pool: - description: "Basic Information of Warm Pool" - $ref: "#/definitions/WarmPoolInfo" - WarmPoolInfo: - type: "object" - properties: - min_capacity: - type: "integer" - format: "int32" - description: "Minimum capacity of the warm pool" - max_capacity: - type: "integer" - format: "int32" - description: "Maximum capacity of the warm pool" - instance_init_wait_time: - type: "integer" - format: "int32" - description: "Waiting time for instance initialization" - status: - type: "string" - description: "Warm Pool State" - WarmPoolInstance: - type: "object" - properties: - id: - type: "string" - description: "Warm Pool Instance ID" - instance_id: - type: "string" - description: "Corresponding virtual machine ID" - name: - type: "string" - description: "Name of the Warm Pool Instance" - status: - type: "string" - description: "Status of Warm Pool Instance" - WarmPoolInstancesResult: - type: "object" - properties: - page_info: - description: "Pagination Information" - $ref: "#/definitions/PageInfo" - warm_pool_instances: - type: "array" - description: "Warm Pool Instance List" - items: - $ref: "#/definitions/WarmPoolInstance" diff --git a/docs/as/openapi/as_v1_en_fix.yaml b/docs/as/openapi/as_v1_en_fix.yaml deleted file mode 100755 index 39fe1882f..000000000 --- a/docs/as/openapi/as_v1_en_fix.yaml +++ /dev/null @@ -1,10975 +0,0 @@ -swagger: "2.0" -info: - description: "API Management" - version: "v1" - title: "AS" -host: "as.br-iaas-odin1.huaweicloud.com" -basePath: "/" -tags: - - name: "API Management" - - name: "AS Configurations" - - name: "AS Groups" - - name: "AS Policies(V1)" - - name: "AS Policies(V2)" - - name: "AS Policy Execution Logs" - - name: "Instances" - - name: "Lifecycle Hooks" - - name: "Notifications" - - name: "Quotas" - - name: "Scaling Action Logs" - - name: "Tags" - - name: "AS Group ScheduledTask" -schemes: - - "https" -consumes: - - "application/json;charset=UTF-8" -produces: - - "application/json;charset=UTF-8" -paths: - /: - get: - tags: - - "API Management" - summary: "Querying API Versions" - description: "This interface is used to query all API versions of the AS service." - operationId: "ListApiVersions" - parameters: [] - responses: - "200": - description: "Normal" - examples: - application/json: - versions: - - links: - - rel: "self" - href: "https://as.XXX.mycloud.com/autoscaling-api/v1/" - id: "v1" - min_version: "" - status: "CURRENT" - updated: "2016-06-30T00:00:00Z" - version: "" - - links: - - rel: "self" - href: "https://as.XXX.mycloud.com/autoscaling-api/v2/" - id: "v2" - min_version: "" - status: "SUPPORTED" - updated: "2018-03-30T00:00:00Z" - version: "" - schema: - $ref: "#/definitions/ApiVersions" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-support-sdk: "Y" - x-name: "Querying API Versions" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /{api_version}: - get: - tags: - - "API Management" - summary: "Querying a Specified API Version" - description: "This interface is used to query a specified API version of the AS service." - operationId: "ShowApiVersion" - parameters: - - name: "api_version" - in: "path" - description: "Specifies the ID of the AS API version." - required: true - type: "string" - enum: - - "v1" - - "v2" - x-request: "v1" - responses: - "200": - description: "Normal" - examples: - application/json: - version: - links: - - rel: "self" - href: "https://as.XXX.mycloud.com/autoscaling-api/v1/" - id: "v1" - min_version: "" - status: "CURRENT" - updated: "2016-06-30T00:00:00Z" - version: "" - schema: - $ref: "#/definitions/ApiVersion" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-support-sdk: "Y" - x-name: "Querying a Specified API Version" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/v1" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_configuration: - get: - tags: - - "AS Configurations" - summary: "Querying AS Configurations" - description: "This API is used to query AS configurations based on search criteria. The results are displayed by page.Search criteria can be the AS configuration name, image ID, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS configurations can be queried for a tenant by default." - operationId: "ListScalingConfigs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_configuration_name" - in: "query" - description: |- - Specifies the AS configuration name. - - Supports fuzzy search. - required: false - type: "string" - x-order: 3 - x-example: "test" - - name: "image_id" - in: "query" - description: "Specifies the image ID. It is same as imageRef." - required: false - type: "string" - x-order: 4 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - x-order: 5 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value range is 0 to 100." - required: false - type: "integer" - x-order: 6 - x-example: 5 - responses: - "200": - description: "Normal" - examples: - application/json: - total_number: 2 - start_number: 0 - limit: 10 - scaling_configurations: - - tenant: "06057680f980d5762f0cc01cc6a3a509" - scaling_configuration_id: "8249ba60-321c-4a02-a0ca-c38fdd54ab0f" - scaling_configuration_name: "as-config-9818" - instance_config: - flavorRef: "s2.medium.2" - imageRef: "4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "KeyPair-4671-test" - key_fingerprint: "SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs" - adminPass: "***" - metadata: {} - security_groups: - - id: "c7033a8e-77bd-41db-a6f4-5788c0bb7fa9" - multi_flavor_priority_policy: "PICK_FIRST" - scaling_group_id: "5294b80e-ee63-4116-bb71-4ea4cadba995" - create_time: "2021-04-17T07:44:24Z" - - tenant: "06057680f980d5762f0cc01cc6a3a509" - scaling_configuration_id: "ad8ff7b8-eac8-4b91-8ca6-b0fa5391aceb" - scaling_configuration_name: "as-config-01" - instance_config: - flavorRef: "s2.medium.2,s2.medium.4,s6.small.1" - imageRef: "4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "KeyPair-4671-test" - key_fingerprint: "SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs" - adminPass: "***" - metadata: {} - security_groups: - - id: "c7033a8e-77bd-41db-a6f4-5788c0bb7fa9" - multi_flavor_priority_policy: "PICK_FIRST" - scaling_group_id: "4201a1cd-461c-447e-aa7a-a85aeabea5a3" - create_time: "2021-04-10T03:25:24Z" - schema: - $ref: "#/definitions/ScalingConfigListResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the AS configurations with image ID 37ca2b35-6fc7-47ab-93c7-900324809c5c." - x-support-sdk: "Y" - x-name: "Querying AS Configurations" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration?image_id=37ca2b35-6fc7-47ab-93c7-900324809c5c" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - post: - tags: - - "AS Configurations" - summary: "Creating an AS Configuration" - description: "This API is used to create an AS configuration.An AS configuration is a template specifying specifications for the instances to be added to an AS group.The AS configuration is decoupled from the AS group. An AS configuration can be used by multiple AS groups.Up to 100 AS configurations can be created for each user." - operationId: "CreateScalingConfig" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingConfigOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_configuration_id: "f8327883-6a07-4497-9a61-68c03e8e72a2" - schema: - $ref: "#/definitions/ScalingConfigId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-request-examples-description-1: "This example shows how to create an AS configuration with name as-config-tlzp, image ID 627a1223-2ca3-46a7-8d5f-7aef22c74ee6, flavor ID s3.xlarge.4, 40 GB SATA system disk, and SSH key name 100vm_key." - x-support-sdk: "Y" - x-name: "Creating an AS Configuration" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration" - x-request-examples-1: - scaling_configuration_name: "as-config-tlzq" - instance_config: - flavorRef: "s3.xlarge.4" - imageRef: "627a1223-2ca3-46a7-8d5f-7aef22c74ee6" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "100vm_key" - security_groups: - - id: "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" - x-request-examples-text-1: - scaling_configuration_name: "as-config-tlzq" - instance_config: - flavorRef: "s3.xlarge.4" - imageRef: "627a1223-2ca3-46a7-8d5f-7aef22c74ee6" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "100vm_key" - security_groups: - - id: "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}: - get: - tags: - - "AS Configurations" - summary: "Querying AS Configuration Details" - description: "This interface is used to query details about an AS configuration by configuration ID." - operationId: "ShowScalingConfig" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_configuration_id" - in: "path" - description: "Specifies an AS configuration ID, which is unique globally." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_configurations: - tenant: "ce061903a53545dcaddb300093b477d2" - scaling_configuration_id: "6afe46f9-7d3d-4046-8748-3b2a1085ad86" - scaling_configuration_name: "config-name-1" - instance_config: - flavorRef: "s2.medium.2" - imageRef: "4ffe0dc8-ac16-4d3a-a1e9-5640e4930cea" - disk: - - size: 40 - volume_type: "SATA" - disk_type: "SYS" - key_name: "KeyPair-4671-test" - key_fingerprint: "SHA256:eX6af8hJmcx0FPZu36+E7w8snfp1JwyLb7Qc7qADeIs" - adminPass: "***" - metadata: {} - security_groups: - - id: "c7033a8e-77bd-41db-a6f4-5788c0bb7fa9" - multi_flavor_priority_policy: "PICK_FIRST" - create_time: "2018-07-23T01:04:07Z" - scaling_group_id: "4201a1cd-461c-447e-aa7a-a85aeabea5a3" - schema: - $ref: "#/definitions/QueryScalingConfigResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-text-1: "This example shows how to query details about the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86." - x-request-examples-1: "This example shows how to query details about the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86." - x-support-sdk: "Y" - x-name: "Querying AS Configuration Details" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Configurations" - description: "Modifying AS Configurations" - summary: "Modifying AS Configurations" - operationId: "UpdateScalingConfig" - parameters: - - name: "project_id" - in: "path" - required: true - type: "string" - - name: "scaling_configuration_id" - in: "path" - required: true - type: "string" - - name: "X-Auth-Token" - in: "header" - required: false - type: "string" - - in: "body" - name: "bodyparam" - required: true - schema: - $ref: "#/definitions/UpdateScalingConfigOption" - responses: - "204": - description: "Request succeeded" - x-api-type: "open-api" - x-support-sdk: "Y" - x-apiexplorer-hide: false - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/8552e3ad-f1b7-4fb1-a8ee-7f715deef8f0" - x-request-examples-description-1: "In this example, the image ID of the AS configuration 8552e3ad-f1b7-4fb1-a8ee-7f715deef8f0 is changed to 3aa499ee-a1f5-4496-8fa8-746be73a9656." - x-request-examples-text-1: - instance_config: - imageRef: "3aa499ee-a1f5-4496-8fa8-746be73a9656" - x-request-examples-1: - instance_config: - imageRef: "3aa499ee-a1f5-4496-8fa8-746be73a9656" - delete: - tags: - - "AS Configurations" - summary: "Deleting an AS Configuration" - description: "This interface is used to delete a specified AS configuration." - operationId: "DeleteScalingConfig" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_configuration_id" - in: "path" - description: "Specifies the AS configuration ID" - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86." - x-support-sdk: "Y" - x-name: "Deleting an AS Configuration" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 4 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_configurations: - post: - tags: - - "AS Configurations" - summary: "Batch Deleting AS Configurations" - description: |- - This interface is used to batch delete AS configurations. - - AS configurations used by AS groups cannot be deleted. - A maximum of 50 AS configurations can be deleted at a time. - operationId: "BatchDeleteScalingConfigs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchDeleteScalingConfigOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS configurations with IDs config1 and config2 in a batch." - x-support-sdk: "Y" - x-name: "Batch Deleting AS Configurations" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_configurations" - x-request-examples-1: - scaling_configuration_id: - - "config1" - - "config2" - x-request-examples-text-1: - scaling_configuration_id: - - "config1" - - "config2" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_group: - get: - tags: - - "AS Groups" - summary: "Querying AS Groups" - description: "This API is used to query AS groups based on search criteria. The results are displayed by page.Search criteria can be the AS group name, AS configuration ID, AS group status, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS groups can be queried for a tenant by default." - operationId: "ListScalingGroups" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_name" - in: "query" - description: |- - Specifies the AS group name. - - Supports fuzzy search. - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 3 - x-example: "test" - - name: "scaling_configuration_id" - in: "query" - description: "Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS Configurations.(https://support.huaweicloud.com/intl/en-us/api-as/as_06_0202.html)" - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 4 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_group_status" - in: "query" - description: |- - Specifies the AS group status. The options are as follows: - - INSERVICE: indicates that the AS group is functional. - PAUSED: indicates that the AS group is paused. - ERROR: indicates that the AS group malfunctions. - DELETING: indicates that the AS group is being deleted. - required: false - type: "string" - enum: - - "INSERVICE" - - "PAUSED" - - "ERROR" - - "DELETING" - x-order: 5 - x-example: "INSERVICE" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum value is 0, and there is no limit on the maximum value." - required: false - type: "integer" - x-order: 6 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - x-order: 7 - x-example: 5 - - name: "enterprise_project_id" - in: "query" - description: "Specifies the enterprise project ID. If all_granted_eps is specified, AS groups in all enterprise projects you have permissions to are listed. For how to obtain an enterprise project ID, see Listing Enterprise Projects(https://support.huaweicloud.com/intl/en-us/api-em/en-us_topic_0121230880.html).NOTE:A Huawei Cloud account and its IAM users assigned with global permissions can view all the AS groups in the account.If an IAM user is assigned with permissions to more 100 enterprise projects, the user can only view the AS groups in the first 100 enterprise projects." - required: false - type: "string" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_groups: - - scaling_group_name: "as-group-dd48" - scaling_group_id: "7d03f471-779e-46b7-a4cd-9601e639e08a" - scaling_group_status: "INSERVICE" - scaling_configuration_id: "57da4923-6067-4952-bedd-f70744332be8" - scaling_configuration_name: "as-config-3565" - current_instance_number: 0 - desire_instance_number: 0 - min_instance_number: 0 - max_instance_number: 1 - cool_down_time: 300 - lbaas_listeners: [] - networks: - - id: "c1a2fdf3-7d65-46bd-a967-039cdea0abd2" - ipv6_enable: false - allowed_address_pairs: [] - available_zones: - - "XXXA" - - "XXXB" - security_groups: [] - create_time: "2021-04-14T03:09:18Z" - vpc_id: "0f9c6ff3-84b9-4f65-be8a-00d6f22572d1" - health_periodic_audit_method: "NOVA_AUDIT" - health_periodic_audit_time: 5 - health_periodic_audit_grace_period: 600 - instance_terminate_policy: "OLD_CONFIG_OLD_INSTANCE" - is_scaling: false - delete_publicip: true - delete_volume: true - enterprise_project_id: "0" - multi_az_priority_policy: "EQUILIBRIUM_DISTRIBUTE" - tags: null - total_number: 1 - start_number: 0 - limit: 10 - schema: - $ref: "#/definitions/ScalingGroupsResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query AS groups with name as-group-test and AS configuration ID 1d281494-6085-4579-b817-c1f813be835f." - x-support-sdk: "Y" - x-name: "Querying AS Groups" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 78 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - post: - tags: - - "AS Groups" - summary: "Creating an AS Group" - description: "An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions. An AS group specifies parameters, such as the maximum number of instances, expected number of instances, minimum number of instances, VPC, subnet, and load balancing.Each user can create a maximum of 10 AS groups by default.If ELB is configured, AS automatically binds or unbinds a load balancer to or from an instance when the instance is added or removed from the AS group.If an AS group uses ELB health check, the listening ports on the load balancers must be enabled for the instances in the AS group. Enable the listening ports in security groups." - operationId: "CreateScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingGroupOption" - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingGroupId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "The following example shows how to create an AS group:The AS group is named GroupNameTest.The AS configuration ID is 47683a91-93ee-462a-a7d7-484c006f4440.The VPC ID is a8327883-6b07-4497-9c61-68d03ee193a, and the network ID is 3cd35bca-5a10-416f-8994-f79169559870.The maximum number of instances is 10, the expected number of instances is 0, and the minimum number of instances is 0.The health check method is ECS health check.When adjusting the number of instances, select target AZ based on the PICK FIRST policy." - x-support-sdk: "Y" - x-name: "Creating an AS Group" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group" - x-request-examples-1: - scaling_group_name: "GroupNameTest" - scaling_configuration_id: "47683a91-93ee-462a-a7d7-484c006f4440" - desire_instance_number: 0 - min_instance_number: 0 - max_instance_number: 10 - health_periodic_audit_method: "NOVA_AUDIT" - vpc_id: "a8327883-6b07-4497-9c61-68d03ee193a" - available_zones: - - "XXXa" - - "XXXb" - networks: - - id: "3cd35bca-5a10-416f-8994-f79169559870" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - multi_az_priority_policy: "PICK_FIRST" - x-request-examples-text-1: - scaling_group_name: "GroupNameTest" - scaling_configuration_id: "47683a91-93ee-462a-a7d7-484c006f4440" - desire_instance_number: 0 - min_instance_number: 0 - max_instance_number: 10 - health_periodic_audit_method: "NOVA_AUDIT" - vpc_id: "a8327883-6b07-4497-9c61-68d03ee193a" - available_zones: - - "XXXa" - - "XXXb" - networks: - - id: "3cd35bca-5a10-416f-8994-f79169559870" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - multi_az_priority_policy: "PICK_FIRST" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 26 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 260 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}: - get: - tags: - - "AS Groups" - summary: "Querying AS Group Details" - description: "This API is used to query details about a specified AS group by group ID." - operationId: "ShowScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_group: - networks: - - id: "a8327883-6b07-4497-9c61-68d03ee193a" - ipv6_enable: true - ipv6_bandwidth: - id: "076ee2ff-f23e-4338-b8ac-1bc7278532d5" - allowed_address_pairs: [] - avaiable_zones: - - "XXXA" - - "XXXB" - scaling_group_name: "as-group-test" - scaling_group_id: "77a7a397-7d2f-4e79-9da9-6a35e2709150" - scaling_group_status: "INSERVICE" - scaling_configuration_id: "1d281494-6085-4579-b817-c1f813be835f" - scaling_configuration_name: "as-config-test" - current_instance_number: 0 - desire_instance_number: 1 - min_instance_number: 0 - max_instance_number: 500 - cool_down_time: 300 - security_groups: - - id: "8a4b1d5b-0054-419f-84b1-5c8a59ebc829" - create_time: "2018-07-23T02:46:29Z" - vpc_id: "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2" - health_periodic_audit_method: "ELB_AUDIT" - health_periodic_audit_time: 5 - health_periodic_audit_grace_period: 600 - instance_terminate_policy: "OLD_CONFIG_OLD_INSTANCE" - is_scaling: false - delete_publicip: false - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - multi_az_priority_policy: "PICK_FIRST" - tags: null - schema: - $ref: "#/definitions/ScalingGroupResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the AS group with ID d4e50321-3777-4135-97f8-9f5e9714a4b0." - x-support-sdk: "Y" - x-name: "Querying AS Group Details" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/d4e50321-3777-4135-97f8-9f5e9714a4b0" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Groups" - summary: "Modifying an AS Group" - description: "This API is used to modify a specified AS group.When the AS configuration of an AS group is changed, the existing instances created using the original AS configuration are not affected.If no scaling action is being performed, you can modify its subnet, ELB, and AZ configurations.Changing the number of expected instances in an AS group will trigger a scaling action to add or remove instances to or from the AS group. The number of expected instances must be greater than or equal to the minimum number of instances and less than or equal to the maximum number of instances." - operationId: "UpdateScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScalingGroupOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_group_id: "a8327883-6b07-4497-9c61-68d03ee193a1" - schema: - $ref: "#/definitions/ScalingGroupId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to change the name, AS configuration, enterprise project, expected number of instances, minimum number of instances, maximum number of instances, and cooldown period of the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1." - x-support-sdk: "Y" - x-name: "Modifying an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 4 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1" - x-request-examples-1: - scaling_group_name: "group_1" - scaling_configuration_id: "f8327883-6a07-4497-9a61-68c03e8e72a2" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - desire_instance_number: 1 - min_instance_number: 1 - max_instance_number: 3 - cool_down_time: 200 - multi_az_priority_policy: "PICK_FIRST" - x-request-examples-text-1: - scaling_group_name: "group_1" - scaling_configuration_id: "f8327883-6a07-4497-9a61-68c03e8e72a2" - enterprise_project_id: "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413" - desire_instance_number: 1 - min_instance_number: 1 - max_instance_number: 3 - cool_down_time: 200 - multi_az_priority_policy: "PICK_FIRST" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "AS Groups" - summary: "Deleting an AS Group" - description: "This interface is used to delete a specified AS group.force_delete specifies whether to forcibly delete an AS group, remove the ECS instances and release them when the AS group is running instances or performing scaling actions. By default, its value is no, which means not to forcibly delete the AS group.If the value of force_delete is set to no, the AS group can be deleted only when both the following conditions are met:The AS group is performing no scaling action.The number of running ECS instances (current_instance_number) is 0.If the value of force_delete is set to yes, the AS group enters the DELETING state, rejecting new requests for scaling actions while completing the existing scaling actions. Then, all ECS instances are removed from the AS group and the AS group is deleted. Note that the manually added ECS instances will be removed from the AS group and the ECS instances automatically created by AS will be automatically deleted." - operationId: "DeleteScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "force_delete" - in: "query" - description: |- - Specifies whether to forcibly delete an AS group. Options: - - no (default): indicates that the AS group is not forcibly deleted. - yes: indicates to forcibly delete an AS group. - required: false - type: "string" - enum: - - "yes" - - "no" - x-order: 4 - x-example: "yes" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to forcibly delete the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1." - x-support-sdk: "Y" - x-name: "Deleting an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1?force_delete=yes" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action: - post: - tags: - - "AS Groups" - summary: "Enabling an AS Group" - description: "This interface is used to enable or disable a specified AS group.NOTE:For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an in-progress scaling action, the scaling action does not stop immediately after the AS group is disabled." - operationId: "ResumeScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyParam" - description: "BodyParamters" - required: true - schema: - $ref: "#/definitions/ResumeScalingGroupOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to enable the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1." - x-support-sdk: "Y" - x-name: "Enabling an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 6 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action" - x-request-examples-1: - action: "resume" - x-request-examples-text-1: - action: "resume" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action": - post: - tags: - - "AS Groups" - summary: "Disabling an AS Group" - description: "This interface is used to enable or disable a specified AS group.NOTE:For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an in-progress scaling action, the scaling action does not stop immediately after the AS group is disabled." - operationId: "PauseScalingGroup" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyParam" - description: "BodyParamters" - required: true - schema: - $ref: "#/definitions/PauseScalingGroupOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Disabling an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 6 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action{ \"action\": \"pause\"}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action{ \"action\": \"pause\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy: - post: - tags: - - "AS Policies(V1)" - summary: "Creating an AS Policy" - description: "This API is used to create an AS policy.An AS policy defines whether to increase or decrease the number of instances in an AS group. If the number and the expected number of instances in an AS group are different due to the execution of the AS policy, AS automatically adjusts the number of instances to the expected.AS supports the following policies: alarm-triggered policy, periodic policy, and scheduled policy.In the execution of the AS policy, you can set the number of instances to be scaled or perform a scaling action according to a percentage specified in the AS policy." - operationId: "CreateScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingPolicyOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create a periodic AS policy named as-policy-7a75. The policy takes effect from 2015-12-14T03:34Z through 2015-12-27T03:34Z. During this period, one instance will be added to AS group with ID 5bc3aa02-b83e-454c-aba1-4d2095c68f8b at 16:00 every day." - x-support-sdk: "Y" - x-name: "Creating an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy" - x-request-examples-1: - scaling_policy_name: "as-policy-7a75" - scaling_policy_action: - operation: "ADD" - instance_number: 1 - cool_down_time: 900 - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - scaling_policy_type: "RECURRENCE" - scaling_group_id: "5bc3aa02-b83e-454c-aba1-4d2095c68f8b" - x-request-examples-text-1: - scaling_policy_name: "as-policy-7a75" - scaling_policy_action: - operation: "ADD" - instance_number: 1 - cool_down_time: 900 - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - scaling_policy_type: "RECURRENCE" - scaling_group_id: "5bc3aa02-b83e-454c-aba1-4d2095c68f8b" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}: - get: - tags: - - "AS Policies(V1)" - summary: "Querying an AS Policy" - description: "This API is used to query details about a specified AS policy by policy ID." - operationId: "ShowScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "" - examples: - application/json: - scaling_policy: - scaling_policy_id: "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - scaling_policy_name: "schedule1" - scaling_policy_type: "SCHEDULED" - scheduled_policy: - launch_time: "2015-07-24T01:21Z" - cool_down_time: 300 - scaling_policy_action: - operation: "REMOVE" - instance_number: 1 - policy_status: "INSERVICE" - create_time: "2015-07-24T01:09:30Z" - schema: - $ref: "#/definitions/ScalingV1Policy" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the AS policy with ID fd7d63ce-8f5c-443e-b9a0-bef9386b23b3." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 8 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Policies(V1)" - summary: "Modifying an AS Policy" - description: "Modifying an AS Policy" - operationId: "UpdateScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies an AS policy ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScalingPolicyOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to modify the periodic AS policy with ID 0h327883-324n-4dzd-9c61-68d03ee191dd for an AS group with two instances. The modification is as follows: The AS policy name is changed to policy_01, and the modification is executed at 16:00 every day from 2016-01-08T17:31Z through 2016-02-08T17:31Z." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Modifying an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd" - x-request-examples-1: - scaling_policy_type: "RECURRENCE" - scaling_policy_name: "policy_01" - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - end_time: "2016-02-08T17:31Z" - start_time: "2016-01-08T17:31Z" - scaling_policy_action: - operation: "SET" - instance_number: 2 - x-request-examples-text-1: - scaling_policy_type: "RECURRENCE" - scaling_policy_name: "policy_01" - scheduled_policy: - launch_time: "16:00" - recurrence_type: "Daily" - end_time: "2016-02-08T17:31Z" - start_time: "2016-01-08T17:31Z" - scaling_policy_action: - operation: "SET" - instance_number: 2 - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "AS Policies(V1)" - summary: "Deleting an AS Policy" - description: "This interface is used to delete a specified AS policy." - operationId: "DeleteScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 11 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list: - get: - tags: - - "AS Policies(V1)" - summary: "Querying AS Policies" - description: "This API is used to query AS policies based on search criteria. The results are displayed by page.Search criteria can be the AS policy name, policy type, policy ID, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS policies for a specified AS group can be queried for a tenant by default." - operationId: "ListScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_policy_name" - in: "query" - description: "Specifies the AS policy name." - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 4 - x-example: "test" - - name: "scaling_policy_type" - in: "query" - description: |- - Specifies the AS policy type. - - ALARM: alarm policy - SCHEDULED: scheduled policy - RECURRENCE: periodic policy - required: false - type: "string" - maxLength: 64 - minLength: 1 - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - x-order: 5 - x-example: "ALARM" - - name: "scaling_policy_id" - in: "query" - description: "Specifies the AS policy ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 6 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - format: "int32" - x-order: 7 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - maximum: 100 - minimum: 0 - x-order: 8 - x-example: 5 - responses: - "200": - description: "Normal" - examples: - application/json: - limit: 20 - total_number: 1 - start_number: 0 - scaling_policies: - - scaling_policy_id: "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - scaling_policy_name: "as-policy-test" - scaling_policy_type: "SCHEDULED" - scheduled_policy: - launch_time: "2015-07-24T01:21Z" - cool_down_time: 300 - scaling_policy_action: - operation: "REMOVE" - instance_number: 1 - policy_status: "INSERVICE" - create_time: "2015-07-24T01:09:30Z" - schema: - $ref: "#/definitions/ScalingV1Policies" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query scheduled AS policies named as-policy-test in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?scaling_policy_name=as-policy-test&scaling_policy_type=SCHEDULED" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policies/action: - post: - tags: - - "AS Policies(V1)" - summary: "Batch Managing AS Policies" - description: "This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time." - operationId: "BatchDeleteScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchDeleteScalingPoliciesOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS policies with IDs policy_id1 and policy_id2 in a batch." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Batch Managing AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 12 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action" - x-request-examples-1: - action: "delete" - scaling_policy_id: - - "policy_id1" - - "policy_id2" - x-request-examples-text-1: - action: "delete" - scaling_policy_id: - - "policy_id1" - - "policy_id2" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_policies/action": - post: - tags: - - "AS Policies(V1)" - summary: "Batch Managing AS Policies" - description: "This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time." - operationId: "BatchPauseScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchPauseScalingPoliciesOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Batch Managing AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 12 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"pause\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"pause\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "02 /autoscaling-api/v1/{project_id}/scaling_policies/action": - post: - tags: - - "AS Policies(V1)" - summary: "Batch Managing AS Policies" - description: "This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time." - operationId: "BatchResumeScalingPolicies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchResumeScalingPoliciesOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Batch Managing AS Policies" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 12 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"resume\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ \"action\": \"resume\", \"scaling_policy_id\": [ \"policy_id1\", \"policy_id2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action: - post: - tags: - - "AS Policies(V1)" - summary: "Executing an AS Policy" - description: "This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails." - operationId: "ExecuteScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/ExecuteScalingPolicyOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to immediately execute the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Executing an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 10 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action" - x-request-examples-1: - action: "execute" - x-request-examples-text-1: - action: "execute" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action": - post: - tags: - - "AS Policies(V1)" - summary: "Enabling an AS Policy" - description: "This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails." - operationId: "ResumeScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/ResumeScalingPolicyOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Enabling an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 10 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"resume\"}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"resume\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "02 /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action": - post: - tags: - - "AS Policies(V1)" - summary: "Disabling an AS Policy" - description: "This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails." - operationId: "PauseScalingPolicy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/PauseScalingPolicyOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Disabling an AS Policy" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 10 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"pause\"}" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action{ \"action\": \"pause\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v2/{project_id}/scaling_policy: - get: - tags: - - "AS Policies(V2)" - summary: "Querying AS Policies (V2)" - description: "This API is used to query all AS policies for a tenant based on search criteria. The results are displayed by page.Search criteria can be the AS resource ID, AS resource type, AS policy name, AS policy ID, alarm ID, enterprise project ID, start line number, number of records, and sorting method.If no search criteria are specified, a maximum of 20 AS policies can be queried for a tenant by default.NOTE:The bandwidth scaling policy configured for a released EIP still occupies the quota of bandwidth scaling policy. The policy is only visible to the Huawei Cloud account and its IAM users with the global permissions." - operationId: "ListAllScalingV2Policies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_resource_id" - in: "query" - description: "Specifies the scaling resource ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_resource_type" - in: "query" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - required: false - type: "string" - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - x-order: 4 - x-example: "SCALING_GROUP" - - name: "scaling_policy_name" - in: "query" - description: "Specifies the AS policy name." - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 5 - x-example: "test" - - name: "scaling_policy_type" - in: "query" - description: |- - Specifies the AS policy type. - - ALARM: alarm policy - SCHEDULED: scheduled policy - RECURRENCE: periodic policy - required: false - type: "string" - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - x-order: 6 - x-example: "ALARM" - - name: "scaling_policy_id" - in: "query" - description: "Specifies the AS policy ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 7 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - format: "int32" - x-order: 8 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - format: "int32" - x-order: 9 - x-example: 5 - - name: "sort_by" - in: "query" - description: "Specifies the sorting method.POLICY_NAME: AS policies are sorted by name.TRIGGER_CONDITION: AS policies are sorted by trigger condition. For example, in ascending order, alarm policies are first, and others are sorted in ascending order based on the latest triggering time.CREATE_TIME: AS policies are sorted based on the creation time." - required: false - type: "string" - enum: - - "POLICY_NAME" - - "TRIGGER_CONDITION" - - "CREATE_TIME" - x-order: 10 - x-example: "POLICY_NAME" - - name: "order" - in: "query" - description: |- - Specifies the sorting order. - - ASC: ascending order - DESC: descending order - required: false - type: "string" - enum: - - "ASC" - - "DESC" - x-order: 11 - x-example: "ASC" - - name: "enterprise_project_id" - in: "query" - description: "Specifies the enterprise project ID.If scaling_resource_type is set to SCALING_GROUP andall_granted_eps is transferred:When you use an account on Huawei Cloud or its IAM user with global permissions, this API will query scaling policies of the AS groups in all enterprise projects.When you use an IAM user with permissions to specific enterprise projects, this API will query scaling policies of the AS groups in these enterprise projects.NOTE:If the IAM user has permissions to more than 100 enterprise projects, this API will query only the AS policies of AS groups in the first 100 enterprise projects.If scaling_resource_type is set to BANDWIDTH andall_granted_eps is transferred:When you use an account on Huawei Cloud or its IAM user with global permissions, this API will query scaling policies of the bandwidths in all enterprise projects.When you use an IAM user with permissions to specific enterprise projects, this API will query the scaling policies of bandwidths in the enterprise projects specified by all_granted_eps. For details, see Querying Bandwidths in Elastic IP API Reference(https://support.huaweicloud.com/intl/en-us/api-eip/eip_apiBandwidth_0002.html).If scaling_resource_type is not specified andall_granted_eps is transferred:When you use an account on Huawei Cloud or its IAM user with global permissions, this API will query scaling policies of the AS groups and bandwidths in all enterprise projects.When you use an IAM user with permissions to specific enterprise projects, this API will query the scaling policies of AS groups and bandwidths in the enterprise projects.NOTE:If the IAM user has permissions to more than 100 enterprise projects, this API will only query the scaling policies of AS groups in the first 100 enterprise projects, as well as the scaling policies of bandwidths in the enterprise projects specified by all_granted_eps. For details, see Querying Bandwidths(https://support.huaweicloud.com/intl/en-us/api-eip/eip_apiBandwidth_0002.html)." - required: false - type: "string" - x-order: 12 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "alarm_id" - in: "query" - description: "Specifies the alarm rule ID." - required: false - type: "string" - responses: - "200": - description: "Normal" - examples: - application/json: - limit: 20 - total_number: 1 - start_number: 0 - scaling_policies: - - scaling_policy_id: "803a35a5-38fb-4d27-a042-496c14bc1fb8" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "03:30" - recurrence_type: "Daily" - start_time: "2017-08-28T03:08Z" - end_time: "2017-09-01T03:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T03:02:41Z" - schema: - $ref: "#/definitions/AllScalingPolicies" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query all periodic AS policies for resources with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6." - x-support-sdk: "Y" - x-name: "Querying AS Policies (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 7 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy?scaling_resource_id=8ade64b5-d685-40b8-8582-4ce306ea37a6&scaling_policy_type=RECURRENCE" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - post: - tags: - - "AS Policies(V2)" - summary: "Creating an AS Policy (V2)" - description: "This API is used to create an AS policy for an AS group or bandwidth.The difference between the V2 and V1 APIs for creating an AS policy is that V2 supports creating an AS policy for adjusting bandwidth and differentiating scaling resources by their types." - operationId: "CreateScalingV2Policy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScalingPolicyV2Option" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create an alarm policy named hth_aspolicy_1 with the following configurations: The alarm rule ID is al1513822380493GvlJKZwA8; when the alarm threshold is reached according to the alarm rule, the bandwidth with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6 will be increased by 1 Mbit/s until the bandwidth reaches 10 Mbit/s." - x-support-sdk: "Y" - x-name: "Creating an AS Policy (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy" - x-request-examples-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "BANDWIDTH" - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-request-examples-text-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "BANDWIDTH" - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}: - get: - tags: - - "AS Policies(V2)" - summary: "Querying an AS Policy (V2)" - description: "This API is used to query details about a specified AS policy by policy ID.The difference between the V2 and V1 APIs for querying details of an AS policy is that V2 contains scaling resource types in response messages." - operationId: "ShowScalingV2Policy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy: - scaling_policy_id: "906f73ff-56e8-41b2-a005-8157d0c60361" - scaling_policy_name: "hth_aspolicy_1" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "BANDWIDTH" - scaling_policy_type: "ALARM" - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - limits: 111 - policy_status: "INSERVICE" - create_time: "2018-03-21T08:03:35Z" - meta_data: - metadata_eip_id: "263f0886-de6a-4e21-ad83-814ca9f3844e" - metadata_eip_address: "255.255.255.255" - schema: - $ref: "#/definitions/ScalingV2Policy" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-name: "Querying an AS Policy (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 9 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "AS Policies(V2)" - summary: "Modifying an AS Policy (V2)" - description: "This API is used to modify a specified AS policy.The difference between the V2 and V1 APIs for modifying an AS policy is that V2 supports modifying a scaling resource type." - operationId: "UpdateScalingV2Policy" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_policy_id" - in: "path" - description: "Specifies an AS policy ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScalingV2PolicyOption" - responses: - "200": - description: "Normal" - examples: - application/json: - scaling_policy_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScalingPolicyId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to modify an AS policy with ID 0h327883-324n-4dzd-9c61-68d03ee191dd. The modification is as follows: The AS policy name is changed to hth_aspolicy_1; the alarm ID is changed to al1513822380493GvlJKZwA8; the cooldown period is changed to 900 seconds; the policy execution action is to add a bandwidth of 1 Mbit/s until the bandwidth reaches 10 Mbit/s." - x-support-sdk: "Y" - x-name: "Modifying an AS Policy (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 4 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd" - x-request-examples-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-request-examples-text-1: - alarm_id: "al1513822380493GvlJKZwA8" - cool_down_time: 900 - scaling_policy_action: - size: 1 - operation: "ADD" - limits: 10 - scaling_policy_name: "hth_aspolicy_1" - scaling_policy_type: "ALARM" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_resource_id}/list: - get: - tags: - - "AS Policies(V2)" - summary: "Querying AS Policies (V2)" - description: "This API is used to query AS policies based on search criteria. The results are displayed by page.The difference between the V2 and V1 APIs for querying AS policies is that V2 contains scaling resource types in response messages.Search criteria can be the AS policy name, policy type, policy ID, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS policies for specified resources can be queried for a tenant by default." - operationId: "ListScalingV2Policies" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_resource_id" - in: "path" - description: "Specifies the scaling resource ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_policy_name" - in: "query" - description: "Specifies the AS policy name." - required: false - type: "string" - maxLength: 64 - minLength: 1 - x-order: 4 - x-example: "test" - - name: "scaling_policy_type" - in: "query" - description: |- - Specifies the AS policy type. - - ALARM: alarm policy - SCHEDULED: scheduled policy - RECURRENCE: periodic policy - required: false - type: "string" - x-order: 5 - - name: "scaling_policy_id" - in: "query" - description: "Specifies the AS policy ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 6 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - format: "int32" - x-order: 7 - x-example: 0 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value range is 0 to 100." - required: false - type: "integer" - maximum: 100 - minimum: 0 - x-order: 8 - x-example: 5 - responses: - "200": - description: "Normal" - examples: - application/json: - limit: 20 - total_number: 3 - start_number: 0 - scaling_policies: - - scaling_policy_id: "803a35a5-38fb-4d27-a042-496c14bc1fb8" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "03:30" - recurrence_type: "Daily" - start_time: "2017-08-28T03:08Z" - end_time: "2017-09-01T03:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T03:02:41Z" - - scaling_policy_id: "535fd67e-276b-409c-879e-52f4e09e14bb" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "21:30" - recurrence_type: "Daily" - start_time: "2017-08-28T21:08Z" - end_time: "2017-09-01T21:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T07:35:05Z" - - scaling_policy_id: "37df92f8-73cb-469e-a420-c15f445d2ee1" - scaling_policy_name: "as-policy-7a75" - scaling_resource_id: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - scaling_resource_type: "SCALING_GROUP" - scaling_policy_type: "RECURRENCE" - scheduled_policy: - launch_time: "22:30" - recurrence_type: "Daily" - start_time: "2017-08-28T22:08Z" - end_time: "2017-09-01T22:08Z" - cool_down_time: 900 - scaling_policy_action: - operation: "ADD" - size: 1 - policy_status: "INSERVICE" - create_time: "2017-08-31T07:41:06Z" - schema: - $ref: "#/definitions/QueryScalingPolicyListV2Response" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query all periodic AS policies for resources with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6." - x-support-sdk: "Y" - x-name: "Querying AS Policies (V2)" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 6 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/8ade64b5-d685-40b8-8582-4ce306ea37a6/list?scaling_policy_type=RECURRENCE" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_policy_execute_log/{scaling_policy_id}: - get: - tags: - - "AS Policy Execution Logs" - summary: "Querying AS Policy Execution Logs" - description: "This API is used to query the historical records of AS policy execution based on search criteria. The results are displayed by page.Search criteria can be the log ID, AS resource type, AS resource ID, policy execution type, start time, end time, start line number, and number of records.If no search criteria are specified, a maximum of 20 AS policy execution logs can be queried by default." - operationId: "ListScalingPolicyExecuteLogs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_policy_id" - in: "path" - description: "Specifies the AS policy ID." - required: true - type: "string" - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - x-order: 2 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "log_id" - in: "query" - description: "Specifies the ID of an AS policy execution log." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 4 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "scaling_resource_type" - in: "query" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - required: false - type: "string" - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - x-order: 5 - x-example: "SCALING_GROUP" - - name: "scaling_resource_id" - in: "query" - description: "Specifies the scaling resource ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 6 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "execute_type" - in: "query" - description: |- - Specifies the AS policy execution type. - - SCHEDULED: automatically triggered at a specified time point - RECURRENCE: automatically triggered at a specified time period - ALARM: alarm-triggered - MANUAL: manually triggered - INTERVAL_ALARM: automatically triggered by a refined scaling policy - required: false - type: "string" - enum: - - "SCHEDULED" - - "RECURRENCE" - - "ALARM" - - "MANUAL" - x-order: 7 - x-example: "SCHEDULED" - - name: "start_time" - in: "query" - description: "Specifies the start time that complies with UTC for querying AS policy execution logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 8 - x-example: "2019-03-18T16:00:11Z" - - name: "end_time" - in: "query" - description: "Specifies the end time that complies with UTC for querying AS policy execution logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 9 - x-example: "2019-03-18T16:00:11Z" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - format: "int32" - x-order: 10 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value range is 0 to 100." - required: false - type: "integer" - default: 20 - maximum: 100 - x-order: 11 - x-example: 5 - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/PolicyExecuteLogs" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-text-1: "This example shows how to query the AS policy execution log with ID 05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6." - x-request-examples-1: "This example shows how to query the AS policy execution log with ID 05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6." - x-support-sdk: "Y" - x-name: "Querying AS Policy Execution Logs" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/edcb94a885a84ed3a3fdf8ea4d2741da/scaling_policy_execute_log/05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: 78 - x-source: "SelfDeveloped" - x-timeout: "10s" - x-hybridcloud: 1 - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: 1 - x-ctc: "N" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/list: - get: - tags: - - "Instances" - summary: "Querying Instances in an AS Group" - description: "This API is used to query instances in an AS group based on search criteria. The results are displayed by page.Search criteria can be the instance lifecycle status, instance health status, instance protection status, start line number, and number of records in the AS group.If no search criteria are specified, a maximum of 20 instances in an AS group can be queried by default." - operationId: "ListScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "life_cycle_state" - in: "query" - description: "Specifies the instance lifecycle status in the AS group.INSERVICE: The instance is enabled.PENDING: The instance is being added to the AS group.PENDING_WAIT: The instance is waiting to be added to the AS group.REMOVING: The instance is being removed from the AS group.REMOVING_WAIT: The instance is waiting to be removed from the AS group.STANDBY: The instance is in standby state.ENTERING_STANDBY: The instance is entering the standby state." - required: false - type: "string" - enum: - - "INSERVICE" - - "PENDING" - - "REMOVING" - - "PENDING_WAIT" - - "REMOVING_WAIT" - - "STANDBY" - - "ENTERING_STANDBY" - x-order: 4 - x-example: "REMOVING_WAIT" - - name: "health_status" - in: "query" - description: |- - Specifies the instance health status. - - INITIALIZING: The instance is initializing. - NORMAL: The instance is normal. - ERROR: The instance is abnormal. - required: false - type: "string" - enum: - - "INITIALIZING" - - "NORMAL" - - "ERROR" - x-order: 5 - x-example: "INITIALIZING" - - name: "protect_from_scaling_down" - in: "query" - description: |- - Specifies the instance protection status. - - true: Instance protection is enabled. - false: Instance protection is disabled. - required: false - type: "string" - enum: - - "true" - - "false" - x-order: 6 - x-example: "true" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - format: "int32" - x-order: 7 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - default: 20 - format: "int32" - x-order: 8 - x-example: 10 - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingInstances" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query enabled, healthy instances in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-name: "Querying Instances in an AS Group" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?life_cycle_state=INSERVICE&health_status=NORMAL" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 78 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group_instance/{instance_id}: - delete: - tags: - - "Instances" - summary: "Removing an Instance from an AS Group" - description: "This interface is used to remove a specified instance from an AS group.You can remove instances only in INSERVICE state and only when the number of instances after the removal is greater than or equal to the minimum number of instances allowed.You can remove instances from an AS group only when no scaling action is in progress." - operationId: "DeleteScalingInstance" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "instance_id" - in: "path" - description: "Specifies the instance ID. For details, see Querying Instances in an AS Group(https://support.huaweicloud.com/intl/en-us/api-as/as_06_0301.html)." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "instance_delete" - in: "query" - description: "Specifies whether an instance is deleted when it is removed from the AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted." - required: false - type: "string" - default: "no" - enum: - - "yes" - - "no" - x-order: 4 - x-example: "yes" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to remove but not delete the instance with ID b25c1589-c96c-465b-9fef-d06540d1945c from an AS group." - x-support-sdk: "Y" - x-name: "Removing an Instance from an AS Group" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/b25c1589-c96c-465b-9fef-d06540d1945c?instance_delete=no" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: 26 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 260 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action: - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchAddScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchAddInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to add instances with IDs instance_id_1 and instance_id_2 from the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a in a batch." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: - action: "ADD" - instances_id: - - "instance_id_1" - - "instance_id_2" - x-request-examples-text-1: - action: "ADD" - instances_id: - - "instance_id_1" - - "instance_id_2" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchRemoveScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchRemoveInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"REMOVE\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ], \"instance_delete\": \"yes\"}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"REMOVE\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ], \"instance_delete\": \"yes\"}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "02 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchProtectScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchProtectInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"PROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"PROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "03 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchUnprotectScalingInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchUnprotectInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"UNPROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"UNPROTECT\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "04 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchSetScalingInstancesStandby" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchEnterStandbyInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"ENTER_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"ENTER_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "05 /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action": - post: - tags: - - "Instances" - summary: "Batch Managing Instances" - description: "Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.Set the standby mode or cancel the setting for the instances in an AS group in batches.NOTE:A batch operation can be performed on a maximum of 50 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.You can remove instances from an AS group only when no scaling action is in progress.To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved." - operationId: "BatchUnsetScalingInstancesStantby" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/BatchExitStandByInstancesOption" - x-order: 4 - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page.\\" - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-name: "Batch Managing Instances" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action" - x-request-examples-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"EXIT_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-request-examples-text-1: "POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action{ \"action\": \"EXIT_STANDBY\", \"instances_id\": [ \"instance_id_1\", \"instance_id_2\" ]}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}: - post: - tags: - - "Lifecycle Hooks" - summary: "Creating a Lifecycle Hook" - description: "This interface is used to create a lifecycle hook for an AS group. Up to five lifecycle hooks can be created for one AS group.After the creation, when the AS group performs a scaling action, the lifecycle hook suspends the target instance and sets it to be in Wait (Adding to AS group) or Wait (Removing from AS group) status. This status retains until the timeout duration expires or you manually call back this status.During the instance waiting duration, you can perform customized operations. For example, you can install or configure software on a newly started instance, or download the log file from the instance before the instance terminates." - operationId: "CreateLifyCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateLifeCycleHookOption" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2019-03-18T16:00:11Z" - schema: - $ref: "#/definitions/LifeCycleHookResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create a lifecycle hook named test-hook1 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. The configuration is as follows: The callback operation is ABANDON; the timeout duration is 3600 seconds; the notification topic_urn is urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh; the hook suspends the instance when the instance is started." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Creating a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: "1 " - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-request-examples-1: - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - x-request-examples-text-1: - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/list: - get: - tags: - - "Lifecycle Hooks" - summary: "Querying Lifecycle Hooks" - description: "This interface is used to query lifecycle hooks by AS group ID." - operationId: "ListLifeCycleHooks" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hooks: - - lifecycle_hook_name: "test-hook1" - default_result: "ABANDON" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2016-11-18T04:01:34Z" - - lifecycle_hook_name: "test-hook2" - default_result: "CONTINUE" - default_timeout: 300 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:test" - notification_topic_name: "test" - lifecycle_hook_type: "INSTANCE_TERMINATING" - create_time: "2016-11-17T04:00:34Z" - schema: - $ref: "#/definitions/QueryLifecycleHookListResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the lifecycle hooks of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Lifecycle Hooks" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/{lifecycle_hook_name}: - get: - tags: - - "Lifecycle Hooks" - summary: "Querying a Lifecycle Hook" - description: "This interface is used to query details about a specified lifecycle hook by AS group ID and lifecycle hook name." - operationId: "ShowLifeCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "lifecycle_hook_name" - in: "path" - description: "Specifies the lifecycle hook name." - required: true - type: "string" - x-order: 3 - x-example: "test" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hook_name: "test-hook1" - default_result: "CONTINUE" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2016-11-18T04:01:34Z" - schema: - $ref: "#/definitions/LifeCycleHookResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query details about the lifecycle hook named test-hook1 of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 3 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "Lifecycle Hooks" - summary: "Modifying a Lifecycle Hook" - description: "This interface is used to modify the information about a specified lifecycle hook." - operationId: "UpdateLifeCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "lifecycle_hook_name" - in: "path" - description: "Specifies the lifecycle hook name." - required: true - type: "string" - maxLength: 64 - minLength: 1 - x-order: 4 - x-example: "test" - - in: "body" - name: "bodyparam" - description: "Bodyparameters" - required: true - schema: - $ref: "#/definitions/UpdateLifeCycleHookOption" - responses: - "200": - description: "Normal" - examples: - application/json: - lifecycle_hook_name: "test-hook1" - default_result: "CONTINUE" - default_timeout: 3600 - notification_topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - notification_topic_name: "gsh" - lifecycle_hook_type: "INSTANCE_LAUNCHING" - create_time: "2016-11-18T04:01:34Z" - schema: - $ref: "#/definitions/LifeCycleHookResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to change the callback operation of the lifecycle hook named test-hook1 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a to CONTINUE." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Modifying a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 4 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1" - x-request-examples-1: - default_result: "CONTINUE" - x-request-examples-text-1: - default_result: "CONTINUE" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "Lifecycle Hooks" - summary: "Deleting a Lifecycle Hook" - description: "This interface is used to delete a specified lifecycle hook.When a scaling action is being performed in an AS group, the lifecycle hooks of the AS group cannot be deleted." - operationId: "DeleteLifecycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "lifecycle_hook_name" - in: "path" - description: "Specifies the lifecycle hook name." - required: true - type: "string" - x-order: 4 - x-example: "test" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the lifecycle hook named test-hook1 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 6 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_instance_hook/{scaling_group_id}/callback: - put: - tags: - - "Lifecycle Hooks" - summary: "Calling Back a Lifecycle Hook" - description: "This interface is used to call back the lifecycle hook specified by a scaling instance based on the lifecycle action key or based on the instance ID and lifecycle hook name.If your custom operations were successful before the timeout duration elapses, select Abandon or Continue to complete the lifecycle action.If you require more time to complete your custom operations, select Extend Timeout to enable the instance to remain in a wait state for an additional hour.The callback operation can be performed only when the lifecycle hook of the target instance is in HANGING state." - operationId: "AttachCallbackInstanceLifeCycleHook" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "Bodyparameters" - required: true - schema: - $ref: "#/definitions/CallbackLifeCycleHookOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to use lifecycle token 23880867-6288-4470-98a8-f8bda096b6c4 in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a to perform the ABANDON callback operation." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Calling Back a Lifecycle Hook" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 5 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_instance_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/callback" - x-request-examples-1: - lifecycle_action_result: "ABANDON" - lifecycle_action_key: "23880867-6288-4470-98a8-f8bda096b6c4" - x-request-examples-text-1: - lifecycle_action_result: "ABANDON" - lifecycle_action_key: "23880867-6288-4470-98a8-f8bda096b6c4" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_instance_hook/{scaling_group_id}/list: - get: - tags: - - "Lifecycle Hooks" - summary: "Querying Instance Suspension" - description: "After a lifecycle hook is added, when an AS group performs a scaling action, the lifecycle hook suspends the target instance and sets it to be in waiting state. You can query the instance suspension based on search criteria.Search instance suspension by instance ID.If no search criteria are specified, the suspension about all instances in the specified AS group is queried by default." - operationId: "ListHookInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "instance_id" - in: "query" - description: "Specifies the AS instance ID." - required: false - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - x-order: 1 - responses: - "200": - description: "Normal" - examples: - application/json: - instance_hanging_info: - - instance_id: "b25c1589-c96c-465b-9fef-d06540d1945c" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - lifecycle_hook_name: "hook-test" - lifecycle_action_key: "6ebe6e72-4b09-4adb-ae4a-a91dc0560069" - default_result: "ABANDON" - timeout: "2016-11-15T06:43:41Z" - lifecycle_hook_status: "HANGING" - schema: - $ref: "#/definitions/InstanceListResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the suspension of the instance with ID b25c1589-c96c-465b-9fef-d06540d1945c in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Instance Suspension" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 6 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_instance_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?instance_id=b25c1589-c96c-465b-9fef-d06540d1945c" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id}: - get: - tags: - - "Notifications" - summary: "Querying an AS Group Notification List" - description: "This API is used to query an AS group notification list by group ID." - operationId: "ListScalingNotifications" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - topics: - - topic_name: "gsh" - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - - topic_name: "asdf" - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:asdf" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - schema: - $ref: "#/definitions/ListScalingNotificationsResult" - "400": - description: "Bad Request The server failed to process the request." - "401": - description: "Unauthorized You must enter the username and password to access the requested page." - "403": - description: "Forbidden You are forbidden to access the requested page." - "404": - description: "Not Found The server could not find the requested page." - "405": - description: "Method Not Allowed You are not allowed to use the method specified in the request." - "406": - description: "Not Acceptable The response generated by the server could not be accepted by the client." - "407": - description: "Proxy Authentication You must use the proxy server for authentication so that the request can be processed." - "408": - description: "Request Timeout The request timed out." - "409": - description: "Conflict The request could not be processed due to a conflict." - "500": - description: "Internal Server Error Failed to complete the request because of an internal service error." - "501": - description: "Not Implemented Failed to complete the request because the server does not support the requested function." - "502": - description: "Bad Gateway Failed to complete the request because the request is invalid." - "503": - description: "Service Unavailable Failed to complete the request because the system is unavailable." - "504": - description: "Gateway Timeout A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the notification list of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying an AS Group Notification List" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - put: - tags: - - "Notifications" - summary: "Enabling Notification for an AS Group" - description: "This API is used to enable notification for an AS group. Each time this API is called, the AS group adds a notification topic and scenario. Each AS group supports up to five topics. The notification topic is pre-configured and subscribed by you in SMN. When the live network complies with the notification scenario that matches the notification topic, the AS group sends a notification to your subscription endpoints." - operationId: "CreateScalingNotification" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateNotificationOption" - responses: - "200": - description: "Normal" - examples: - application/json: - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - topic_name: "gsh" - schema: - $ref: "#/definitions/CreateNotificationResult" - "400": - description: "Bad Request The server failed to process the request." - "401": - description: "Unauthorized You must enter the username and password to access the requested page." - "403": - description: "Forbidden You are forbidden to access the requested page." - "404": - description: "Not Found The server could not find the requested page." - "405": - description: "Method Not Allowed You are not allowed to use the method specified in the request." - "406": - description: "Not Acceptable The response generated by the server could not be accepted by the client." - "407": - description: "Proxy Authentication You must use the proxy server for authentication so that the request can be processed." - "408": - description: "Request Timeout The request timed out." - "409": - description: "Conflict The request could not be processed due to a conflict." - "500": - description: "Internal Server Error Failed to complete the request because of an internal service error." - "501": - description: "Not Implemented Failed to complete the request because the server does not support the requested function." - "502": - description: "Bad Gateway Failed to complete the request because the request is invalid." - "503": - description: "Service Unavailable Failed to complete the request because the system is unavailable." - "504": - description: "Gateway Timeout A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to enable notification with topic_urn urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh for the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. After the configuration, a notification will be sent when capacity expansion succeeds or fails, capacity reduction succeeds or fails, or an error occurs in the AS group." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Enabling Notification for an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-request-examples-1: - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - x-request-examples-text-1: - topic_urn: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - topic_scene: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id}/{topic_urn}: - delete: - tags: - - "Notifications" - summary: "Deleting a Notification for an AS Group" - description: "This interface is used to delete a notification for a specified AS group." - operationId: "DeleteScalingNotification" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "topic_urn" - in: "path" - description: "Specifies a unique topic in SMN." - required: true - type: "string" - x-order: 4 - x-example: "urn:smn:regionId:b53e5554fad0494d96206fxxxxx6510b:xxx" - responses: - "204": - description: "Normal" - "400": - description: "Bad Request The server failed to process the request." - "401": - description: "Unauthorized You must enter the username and password to access the requested page." - "403": - description: "Forbidden You are forbidden to access the requested page." - "404": - description: "Not Found The server could not find the requested page." - "405": - description: "Method Not Allowed You are not allowed to use the method specified in the request." - "406": - description: "Not Acceptable The response generated by the server could not be accepted by the client." - "407": - description: "Proxy Authentication You must use the proxy server for authentication so that the request can be processed." - "408": - description: "Request Timeout The request timed out." - "409": - description: "Conflict The request could not be processed due to a conflict." - "500": - description: "Internal Server Error Failed to complete the request because of an internal service error." - "501": - description: "Not Implemented Failed to complete the request because the server does not support the requested function." - "502": - description: "Bad Gateway Failed to complete the request because the request is invalid." - "503": - description: "Service Unavailable Failed to complete the request because the system is unavailable." - "504": - description: "Gateway Timeout A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the notification with topic_urn urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting a Notification for an AS Group" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "26" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "260" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/quotas: - get: - tags: - - "Quotas" - summary: "Querying AS Quotas" - description: "This API is used to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant." - operationId: "ShowResourceQuota" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - responses: - "200": - description: "Normal" - examples: - application/json: - quotas: - resources: - - type: "scaling_Group" - used: 2 - quota: 25 - max: 50 - - type: "scaling_Config" - used: 3 - quota: 100 - max: 200 - - type: "scaling_Policy" - used: -1 - quota: 50 - max: 50 - - type: "scaling_Instance" - used: -1 - quota: 200 - max: 1000 - - type: "bandwidth_scaling_policy" - used: 1 - quota: 10 - max: 100 - schema: - $ref: "#/definitions/QuotaResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Quotas" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/quotas/{scaling_group_id}: - get: - tags: - - "Quotas" - summary: "Querying AS Policy and Instance Quotas" - description: "This interface is used to query the total quotas and used quotas of AS policies and instances of a specified AS group by group ID." - operationId: "ShowPolicyAndInstanceQuota" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - quotas: - resources: - - type: "scaling_Policy" - used: 2 - quota: 50 - max: 50 - - type: "scaling_Instance" - used: 0 - quota: 200 - max: 1000 - schema: - $ref: "#/definitions/PolicyInstanceQuotaResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the total quotas and used quotas of the AS policies and instances in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Policy and Instance Quotas" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling_activity_log/{scaling_group_id}: - get: - tags: - - "Scaling Action Logs" - summary: "Querying Scaling Action Logs" - description: "This API is used to query scaling action logs based on search criteria. The results are displayed by page.Search criteria can be the start time, end time, start line number, and number of records.If no search criteria are specified, a maximum of 20 scaling action logs can be queried by default." - operationId: "ListScalingActivityLogs" - consumes: - - "application/x-www-form-urlencoded" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "start_time" - in: "query" - description: "Specifies the start time that complies with UTC for querying scaling action logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 4 - x-example: "2019-03-18T16:00:11Z" - - name: "end_time" - in: "query" - description: "Specifies the end time that complies with UTC for querying scaling action logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 5 - x-example: "2019-03-18T16:00:11Z" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - format: "int32" - x-order: 6 - x-example: 1 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - default: 20 - maximum: 100 - x-order: 7 - x-example: 5 - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingActivityLogs" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the scaling action logs of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: 1 - x-name: "Querying Scaling Action Logs" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_activity_log/e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: 78 - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: 1 - x-ctc: "Y" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v2/{project_id}/scaling_activity_log/{scaling_group_id}: - get: - tags: - - "Scaling Action Logs" - summary: "Querying Scaling Action Logs (V2)" - description: "This API is used to query scaling action logs based on search criteria. The scaling actions include increasing instances, setting instances to the standby mode, and migrating instances to balance load. The results are displayed by page.The difference between the V2 and V1 APIs for querying scaling action logs is that V2 displays more detailed action logs, such as ELB migration logs and instance standby logs.Search criteria can be the start time, end time, start line number, number of records, and scaling action type.If no search criteria are specified, a maximum of 20 scaling action logs can be queried by default." - operationId: "ListScalingActivityV2Logs" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - x-order: 2 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 3 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "log_id" - in: "query" - description: "Specifies the scaling action log ID." - required: false - type: "string" - - name: "start_time" - in: "query" - description: "Specifies the start time that complies with UTC for querying scaling action logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 4 - x-example: "2019-03-18T16:00:11Z" - - name: "end_time" - in: "query" - description: "Specifies the end time that complies with UTC for querying scaling action logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ." - required: false - type: "string" - x-order: 5 - x-example: "2019-03-18T16:00:11Z" - - name: "start_number" - in: "query" - description: "Specifies the start line number. The default value is 0. The minimum parameter value is 0." - required: false - type: "integer" - default: 0 - maximum: 32768 - x-order: 6 - - name: "limit" - in: "query" - description: "Specifies the number of query records. The default value is 20. The value ranges from 0 to 100." - required: false - type: "integer" - default: 20 - maximum: 100 - x-order: 7 - x-example: 5 - - name: "type" - in: "query" - description: "Specifies the types of the scaling actions to be queried. Different types are separated by commas (,).NORMAL: indicates a common scaling action.MANUAL_REMOVE: indicates manually removing instances from an AS group.MANUAL_DELETE: indicates manually removing and deleting instances from an AS group.MANUAL_ADD: indicates manually adding instances to an AS group.ELB_CHECK_DELETE: indicates that instances are removed from an AS group and deleted based on the ELB health check result.AUDIT_CHECK_DELETE: indicates that instances are removed from an AS group and deleted based on the OpenStack audit.DIFF: indicates that the number of expected instances is different from the actual number of instances.MODIFY_ELB: indicates the load balancer migration.ENTER_STANDBY: indicates setting instances to standby mode.EXIT_STANDBY: indicates canceling standby mode for instances." - required: false - type: "string" - enum: - - "NORMAL" - - "MANNUAL_REMOVE" - - "MANNUAL_DELETE" - - "MANNUAL_ADD" - - "ELB_CHECK_DELETE" - - "AUDIT_CHECK_DELETE" - - "MODIFY_ELB" - x-order: 8 - x-example: "NORMAL" - - name: "status" - in: "query" - description: |- - Specifies the status of the scaling action. - - SUCCESS: The scaling action has been performed. - FAIL: Performing the scaling action failed. - DOING: The scaling action is being performed. - required: false - type: "string" - enum: - - "SUCCESS" - - "FAIL" - - "DOING" - x-example: "DOING" - responses: - "200": - description: "Normal" - schema: - $ref: "#/definitions/ScalingActivityV2Logs" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the scaling action logs of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. The start time is 2018-11-22T00:00:00Z, and the end time is 2018-11-22T14:00:00Z." - x-support-sdk: "Y" - x-name: "Querying Scaling Action Logs (V2)" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_activity_log/e5d27f5c-dd76-4a61-b4bc-a67c5686719a?start_time=2018-11-22T00:00:00Z&end_time=2018-11-22T14:00:00Z" - x-flow_control_group: "as" - x-tenant_flow_time: 1 - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: 78 - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: 1 - x-ctc: "N" - x-hc: "Y" - x-multi_tenant_flow_value: 780 - x-otc: "Y" - /autoscaling-api/v1/{project_id}/{resource_type}/tags: - get: - tags: - - "Tags" - summary: "Querying Tags" - description: "This API is used to query tags of a specific type of resource in a project." - operationId: "ListScalingTagInfosByTenantId" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 3 - x-example: "scaling_group_tag" - responses: - "200": - description: "Normal" - examples: - application/json: - tags: - - key: "ENV15" - values: - - "ENV15" - - key: "111" - values: - - "" - - key: "environment" - values: - - "DEV" - - key: "ENV151" - values: - - "ENV151" - - key: "ENV152" - values: - - "ENV152" - schema: - $ref: "#/definitions/ShowTagByTenantResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query tags of AS groups in a project." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Tags" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 1 - x-request-examples-url-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/tags" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-08-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags: - get: - tags: - - "Tags" - summary: "Querying Tags of a Resource" - description: "This interface is used to query tags of a specified resource in a project." - operationId: "ListScalingTagInfosByResourceId" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 2 - x-example: "scaling_group_tag" - - name: "resource_id" - in: "path" - description: "Specifies the resource ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "200": - description: "Normal" - examples: - application/json: - tags: - - key: "ENV15" - value: "ENV15" - - key: "ENV151" - value: "ENV151" - - key: "ENV152" - value: "ENV152" - schema: - $ref: "#/definitions/QueryTagByResourceIdResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query the tags of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Tags of a Resource" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 2 - x-request-examples-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags" - x-request-examples-text-1: "GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-08-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/{resource_type}/resource_instances/action: - post: - tags: - - "Tags" - summary: "Querying Resources by Tag" - description: "This API is used to query resources in a project by tag.By default, resources and resource tags are in descending order of their creation time." - operationId: "ListResourceInstances" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 1 - - name: "resource_type" - in: "path" - description: "Specifies the resource type. An example value is scaling_group_tag." - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 2 - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/QueryTagsOption" - responses: - "200": - description: "Normal" - examples: - application/json: - resources: - - resource_id: "64af4b6f-ec51-4436-8004-7a8f30080c87" - resource_detail: "SCALING_GROUP_TAG" - tags: - - key: "key" - value: "value" - resource_name: "as_scaling_group_1" - - resource_id: "7122ef51-604b-40e7-b9b2-1de4cd78dc60" - resource_detail: "SCALING_GROUP_TAG" - tags: - - key: "key" - value: "value" - resource_name: "as_scaling_group_2" - marker: "2" - total_count: 2 - schema: - $ref: "#/definitions/QueryTagsResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "Example request when action is set to filterThis example shows how to query AS groups of a tenant using the following search criteria: including tag (key = key1 and value = value), excluding tag (key = key2 and value = value2), index position 100, and maximum number of records 100." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying Resources by Tag" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 4 - x-request-examples-url-1: "POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action" - x-request-examples-1: "{\n offset: \"100\"\n limit: \"100\"\n action: \"filter\"\n matches:\n - key: \"resource_name\"\n value: \"resource1\"\n not_tags: \n - key: \"key2\"\n values: \"values2\"\n tags:\n - key: \"key1\"\n values: \"values1\"\n}" - x-request-examples-text-1: "{\n offset: \"100\"\n limit: \"100\"\n action: \"filter\"\n matches:\n - key: \"resource_name\"\n value: \"resource1\"\n not_tags: \n - key: \"key2\"\n values: \"values2\"\n tags:\n - key: \"key1\"\n values: \"values1\"\n}" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags/action: - post: - tags: - - "Tags" - summary: "This API is used to create or delete a tag. Each AS group can have a maximum of 10 tags added to it." - description: |- - This API is used to create or delete a tag. - - Each AS group can have a maximum of 10 tags added to it. - operationId: "CreateScalingTagInfo" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 3 - - name: "resource_id" - in: "path" - description: "Resource ID" - required: true - type: "string" - x-order: 4 - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateTagsOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to add two tags (key = ENV15 and value = ENV15) and (key = ENV151 and value = ENV151) to the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Creating or Deleting a Tag" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 3 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action" - x-request-examples-1: - tags: - - key: "ENV15" - value: "ENV15" - - key: "ENV151" - value: "ENV151" - action: "create" - x-request-examples-text-1: - tags: - - key: "ENV15" - value: "ENV15" - - key: "ENV151" - value: "ENV151" - action: "create" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - "01 /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags/action": - post: - tags: - - "Tags" - summary: "Creating or Deleting a Tag" - description: "Creating or Deleting a Tag" - operationId: "DeleteScalingTagInfo" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - - name: "resource_type" - in: "path" - description: |- - Specifies the resource type. The option is as follows: - - scaling_group_tag: indicates that the resource type is AS groups. - required: true - type: "string" - enum: - - "scaling_group_tag" - x-order: 3 - - name: "resource_id" - in: "path" - description: "Resource ID" - required: true - type: "string" - x-order: 4 - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/DeleteTagsOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because an internal service error occurred." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the server has received an invalid response." - "503": - description: "Failed to complete the request because the system is currently unavailable." - "504": - description: "A gateway timeout error occurred." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Creating or Deleting a Tag" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public API" - x-order: 3 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action" - x-request-examples-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action { \"tags\":[ { \"key\": \"ENV15\", \"value\": \"ENV15\" }, { \"key\": \"ENV151\", \"value\": \"ENV151\" } ], \"action\": \"delete\" }" - x-request-examples-text-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action { \"tags\":[ { \"key\": \"ENV15\", \"value\": \"ENV15\" }, { \"key\": \"ENV151\", \"value\": \"ENV151\" } ], \"action\": \"delete\" }" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-is-registered: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "N" - x-is_calling: "Y" - x-obc: "N" - x-multi_tenant_flow_time: "1" - x-ctc: "N" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks: - get: - tags: - - "AS Group ScheduledTask" - summary: "Querying AS Scheduled Tasks" - description: "This API is used to query AS scheduled tasks based on search criteria. The results are displayed by page. Currently, the Search criteria only supports scaling group id. If no search criteria are specified, a maximum of 20 AS scheduled tasks for all AS group can be queried for a tenant by default." - operationId: "ListGroupScheduledTasks" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - required: true - type: "string" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "limit" - in: "query" - description: "Specifies count limit for query result." - required: false - type: "integer" - x-order: 4 - x-example: 20 - - name: "marker" - in: "query" - description: "Specifies page marker for query." - required: false - type: "string" - x-order: 5 - x-example: "xxxxxxx" - responses: - "200": - description: "Normal" - examples: - application/json: - page_info: - next_marker: "xxxx" - scheduled_tasks: - - task_id: "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3" - name: "task_01" - status: "INSERVICE" - scheduled_policy: - start_time: "2016-01-08T17:31Z" - end_time: "2016-02-08T17:31Z" - launch_time: "16:00" - recurrence_type: "Daily" - scaling_group_id: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a" - instance_number: - max: 10 - schema: - $ref: "#/definitions/ScheduledTasksResult" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to query scheduled tasks in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Querying AS Scheduled Tasks" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 5 - x-request-examples-url-1: "GET https://{Endpoint} /autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "78" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "780" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - post: - tags: - - "AS Group ScheduledTask" - summary: "Creating an AS Scheduled Task" - description: "'This API is used to create an AS scheduled task. An AS scheduled task defines scheduled policy and corresponding action for an AS Group. Tasks are triggered automatically to perform action that adjusts max instance number and min instance number of AS group. Currently, AS scheduled task supports the following policies: periodic policy and point-in-time policy.'" - operationId: "CreateGroupScheduledTask" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "scaling_group_id" - in: "path" - description: "Specifies the AS group ID." - required: true - type: "string" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/CreateScheduledTaskOption" - responses: - "200": - description: "Normal" - examples: - application/json: - task_id: "0h327883-324n-4dzd-9c61-68d03ee191dd" - schema: - $ref: "#/definitions/ScheduledTaskId" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-request-examples-text-1: - name: "as-scheduled-task-7a75" - scheduled_policy: - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - launch_time: "16:00" - recurrence_type: "DAILY" - instance_number: - max: 10 - min: 5 - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to create a periodic AS task named scheduled-task-7a75. The task takes effect from 2015-12-14T03:34Z through 2015-12-27T03:34Z. During this period, the max instance number will be set to AS group with ID 5bc3aa02-b83e-454c-aba1-4d2095c68f8b at 16:00 every day." - x-support-sdk: "Y" - x-name: "Creating an AS Scheduled Task" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 1 - x-request-examples-url-1: "POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks" - x-request-examples-1: - name: "as-scheduled-task-7a75" - scheduled_policy: - start_time: "2015-12-14T03:34Z" - end_time: "2015-12-27T03:34Z" - launch_time: "16:00" - recurrence_type: "DAILY" - instance_number: - max: 10 - min: 5 - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2016-06-30" - x-tenant_flow_value: "52" - x-hybridcloud: "true" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - /autoscaling-api/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks/{scheduled_task_id}: - put: - tags: - - "AS Group ScheduledTask" - summary: "Modifying an AS Scheduled Task" - description: "Modifying an AS Scheduled Task" - operationId: "UpdateGroupScheduledTask" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies the group ID." - required: true - type: "string" - - name: "scheduled_task_id" - in: "path" - description: "Specifies an AS scheduled task ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - - in: "body" - name: "bodyparam" - description: "BodyParameters" - required: true - schema: - $ref: "#/definitions/UpdateScheduledTaskOption" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-request-examples-text-1: - name: "task_01" - scheduled_policy: - start_time: "2016-01-08T17:31Z" - end_time: "2016-02-08T17:31Z" - launch_time: "16:00" - recurrence_type: "Daily" - instance_number: - max: 10 - min: 5 - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to modify the scheduled task with ID 0h327883-324n-4dzd-9c61-68d03ee191dd for an AS group with two instances. The modification is as follows: The AS scheduled task name is changed to task_01, and the modification is executed at 16:00 every day from 2016-01-08T17:31Z through 2016-02-08T17:31Z." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Modifying an AS Scheduled Task" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 3 - x-request-examples-url-1: "PUT https://{Endpoint} /autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks/0h327883-324n-4dzd-9c61-68d03ee191dd" - x-request-examples-1: - name: "task_01" - scheduled_policy: - start_time: "2016-01-08T17:31Z" - end_time: "2016-02-08T17:31Z" - launch_time: "16:00" - recurrence_type: "Daily" - instance_number: - max: 10 - min: 5 - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" - delete: - tags: - - "AS Group ScheduledTask" - summary: "Deleting an AS Scheduled Task" - description: "This interface is used to delete a specified AS scheduled task." - operationId: "DeleteGroupScheduledTask" - parameters: - - name: "project_id" - in: "path" - description: "Specifies the project ID." - required: true - type: "string" - x-order: 1 - x-example: "0513757xxxxxd5eb2f08xxxb93ef4f0f" - - name: "X-Auth-Token" - in: "header" - description: "Specifies the token" - required: true - type: "string" - x-order: 2 - x-example: "MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..." - - name: "scaling_group_id" - in: "path" - description: "Specifies an AS group ID." - required: true - type: "string" - - name: "scheduled_task_id" - in: "path" - description: "Specifies an AS scheduled task ID." - required: true - type: "string" - x-order: 3 - x-example: "66e0f775-c4ac-xxxx-xxxx-f93ba217aa5f" - responses: - "204": - description: "Normal" - "400": - description: "The server failed to process the request." - "401": - description: "You must enter the username and password to access the requested page." - "403": - description: "You are forbidden to access the requested page." - "404": - description: "The server could not find the requested page." - "405": - description: "You are not allowed to use the method specified in the request." - "406": - description: "The response generated by the server could not be accepted by the client." - "407": - description: "You must use the proxy server for authentication so that the request can be processed." - "408": - description: "The request timed out." - "409": - description: "The request could not be processed due to a conflict." - "500": - description: "Failed to complete the request because of an internal service error." - "501": - description: "Failed to complete the request because the server does not support the requested function." - "502": - description: "Failed to complete the request because the request is invalid." - "503": - description: "Failed to complete the request because the system is unavailable." - "504": - description: "A gateway timeout error occurred." - x-is-registered: "Y" - x-request-examples-description-1: "This example shows how to delete the AS scheduled task with ID 906f73ff-56e8-41b2-a005-8157d0c60361." - x-support-sdk: "Y" - x-hybridcloud: true - x-name: "Deleting an AS Scheduled Task" - x-constraint: "" - x-version: "v1" - x-scope: "Commercial" - x-iftype: "Public Api" - x-order: 11 - x-request-examples-url-1: "DELETE https://{Endpoint} /autoscaling-api/v1/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/scheduled-tasks/906f73ff-56e8-41b2-a005-8157d0c60361" - x-flow_control_group: "as" - x-in_cli: "" - x-tenant_flow_time: "1" - x-hk: "Y" - x-first_open_time: "2018-09-30" - x-tenant_flow_value: "52" - x-source: "SelfDeveloped" - x-apigateway-request-type: "" - x-source_url: "" - x-timeout: "10s" - x-tlf: "Y" - x-is_calling: "Y" - x-obc: "Y" - x-multi_tenant_flow_time: "1" - x-ctc: "Y" - x-apigateway-auth-type: "" - x-call_frequency: "" - x-hc: "Y" - x-un_cli: "" - x-multi_tenant_flow_value: "520" - x-apigateway-match-mode: "" - x-otc: "Y" - x-apiErrorCodes: "" -definitions: - ApiVersions: - type: "object" - properties: - versions: - type: "array" - description: "Specifies the API versions." - items: - $ref: "#/definitions/VersionInfo" - VersionInfo: - type: "object" - properties: - id: - type: "string" - description: "Specifies the API version ID." - enum: - - "v1" - - "v2" - links: - type: "array" - description: "Specifies the API URL." - items: - $ref: "#/definitions/Links" - min_version: - type: "string" - description: "Specifies the earliest supported API version number." - status: - type: "string" - description: |- - Specifies the API version status. - - CURRENT: indicates a primary version. - SUPPORTED: indicates an earlier version which is still supported. - DEPRECATED: indicates a deprecated version which may be deleted later. - enum: - - "CURRENT" - - "SUPPORT" - - "DEPRECATED" - update: - type: "string" - format: "date-time" - description: "Specifies the release date of an API version." - version: - type: "string" - description: "Specifies the latest supported API version number." - Links: - type: "object" - properties: - href: - type: "string" - description: "Specifies the API Uniform Resource Locator (URL)." - rel: - type: "string" - description: "Specifies the API URL dependency." - ApiVersion: - type: "object" - properties: - version: - description: "Specifies a specified API version." - $ref: "#/definitions/VersionInfo" - CreateScalingConfigOption: - type: "object" - properties: - source_scaling_configuration_id: - type: "string" - description: |- - Specifies the ID of the source AS configuration, which will be used together with instance_config to create a new AS configuration. - If instance_id is specified in instance_config, instance_id is preferentially used to create the new AS configuration, and source_scaling_configuration_id does not take effect. - If instance_id is not specified in instance_config, source_scaling_configuration_id and instance_config are used together to create the new AS configuration. - If a parameter in instance_config is set to null, the corresponding setting of the source AS configuration takes effect. - If a parameter in instance_config is not set to null or left empty, this parameter overwrites the corresponding setting of the source AS configuration. - If source_scaling_configuration_id is not specified, scaling_configuration_name and instance_config are mandatory. - minLength: 1 - maxLength: 64 - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_configuration_name: - type: "string" - example: "as-config-tlzq" - description: "Specifies the AS configuration name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - instance_config: - description: "Specifies the ECS configuration." - $ref: "#/definitions/InstanceConfig" - description: "Request parameters" - InstanceConfig: - type: "object" - properties: - instance_id: - type: "string" - description: "Specifies the ECS ID. When using the existing ECS specifications as the template to create AS configurations, specify this parameter. In this case, the flavorRef, imageRef, disk, tenancy, dedicated_host_id, and security_groups fields do not take effect.If the instance_id field is not specified, flavorRef, imageRef, and disk fields are mandatory." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - flavorRef: - type: "string" - description: "Specifies the ECS flavor ID. A maximum of 10 flavors can be selected. Use a comma (,) to separate multiple flavor IDs. You can obtain its value from the API for querying details about flavors and extended flavor information." - minLength: 1 - maxLength: 36 - imageRef: - type: "string" - description: "Specifies the image ID. Its value is the same as that of image_id for specifying the image selected during ECS creation. Obtain the value using the API for querying images. ." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - disk: - type: "array" - description: "Specifies the disk group information. System disks are mandatory and data disks are optional. For details" - items: - $ref: "#/definitions/DiskInfo" - key_name: - type: "string" - description: "Specifies the name of the SSH key pair used to log in to the ECS.NOTE:If both key_name and user_data are specified, user_data only injects user data." - minLength: 1 - maxLength: 32 - personality: - type: "array" - description: "Specifies information about the injected file. Only text files can be injected. A maximum of five files can be injected at a time and the maximum size of each file is 1 KB. For details." - items: - $ref: "#/definitions/PersonalityInfo" - public_ip: - description: "Specifies the EIP of the ECS. The EIP can be configured in two ways. Do not use an EIP. In this case, this parameter is unavailable.Automatically assign an EIP. You need to specify the information about the new EIP." - $ref: "#/definitions/PublicIp" - user_data: - type: "string" - description: "Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.Constraints:The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB.If key_name is not specified, the data injected by user_data is the password of user root for logging in to the ECS by default.This parameter is mandatory when you create a Linux ECS using the password authentication mode. Its value is the initial user root password.Password complexity requirements:Consists of 8 to 26 characters.Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?).NOTE:Data injection is not supported for ECSs that use a Linux image and the password login mode." - metadata: - description: "Specifies the ECS metadata.NOTE:This parameter is mandatory when a Windows ECS with password authentication is created.This parameter does not allow users to write data. It is mandatory when the ECS is to be created using a Windows image." - $ref: "#/definitions/VmMetaData" - security_groups: - type: "array" - description: "Specifies security groups. If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration." - items: - $ref: "#/definitions/SecurityGroups" - server_group_id: - type: "string" - description: "Specifies the ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenancy: - type: "string" - description: |- - Specifies that ECSs are created on DeHs. Options: - - dedicated: Specifies that ECSs are created on DeHs. - This parameter is not specified. - enum: - - "dedicated" - dedicated_host_id: - type: "string" - description: "Specifies the ID of a DeH.NOTE:This parameter is valid only when tenancy is set to dedicated.If this parameter is specified, ECSs will be created on a specified DeH.If this parameter is not specified, the system automatically selects the DeH with the maximum available memory size from the DeHs that meet specifications requirements to create the ECSs, thereby balancing load of the DeHs." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - multi_flavor_priority_policy: - type: "string" - description: "Specifies the priority policy used when there are multiple flavors and instances to be created using an AS configuration.PICK_FIRST (default): When an ECS is added for capacity expansion, the target flavor is determined in the order in the flavorRef list.COST_FIRST: When an ECS is added for capacity expansion, the target flavor is determined for minimal expenses." - enum: - - "PICK_FIRST" - - "COST_FIRST" - market_type: - type: "string" - description: |- - Specifies a billing mode for an ECS. The options are as follows: - - Pay-per-use, which is not specified - Spot pricing - enum: - - "spot" - description: "instance_config field description" - DiskInfo: - type: "object" - required: - - "disk_type" - - "size" - - "volume_type" - properties: - size: - type: "integer" - description: "Specifies the disk size. The unit is GB.The system disk size ranges from 1 to 1024 and must be greater than or equal to the minimum size (min_disk value) of the system disk specified in the image.The data disk size ranges from 10 to 32768." - minimum: 10 - maximum: 32768 - volume_type: - type: "string" - description: "Specifies the ECS system disk type. The disk type must match the available disk type.SATA: common I/O disk typeSAS: high I/O disk typeSSD: ultra-high I/O disk typeGPSSD: general-purpose SSD disk typeco-p1: high I/O (performance-optimized I) disk typeuh-l1: ultra-high I/O (latency-optimized) disk typeIf the specified disk type is not available in the AZ, the disk will fail to create.NOTE:For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks.For details about disk types, see[Disk Types and Disk Performance.](https://support.huaweicloud.com/intl/en-us/productdesc-evs/en-us_topic_0014580744.html)" - enum: - - "SATA" - - "SAS" - - "SSD" - - "co-pl" - - "uh-11" - - "GPSSD" - - "GPSSD2" - - "ESSD2" - default: "SATA" - disk_type: - type: "string" - description: |- - Specifies a disk type. The options are as follows: - - DATA: indicates a data disk. - SYS: indicates a system disk. - NOTE: - System disk encryption is not supported. - enum: - - "SYS" - - "DATA" - default: "SYS" - dedicated_storage_id: - type: "string" - description: "Specifies a DSS device ID for creating an ECS disk.NOTE:Specify DSS devices for all disks in an AS configuration or not. If DSS devices are specified, all the data stores must belong to the same AZ, and the disk types supported by a DSS device for a disk must be the same as the volume_type value." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - data_disk_image_id: - type: "string" - description: "Specifies the ID of a data disk image used to export data disks of an ECS." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - snapshot_id: - type: "string" - description: "Specifies the disk backup snapshot ID for restoring the system disk and data disks using a full-ECS backup when a full-ECS image is used.NOTE:Each disk in an AS configuration must correspond to a disk backup in the full-ECS backup by snapshot_id." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - metadata: - description: "Specifies the metadata for creating disks." - $ref: "#/definitions/MetaData" - iops: - type: "integer" - format: "int32" - description: "Specifies the IOPS configured for an EVS disk. This parameter is mandatory only when volume_type is set to GPSSD2 or ESSD2." - throughput: - type: "integer" - format: "int32" - description: "Specifies the throughput of an EVS disk. The unit is MiB/s. This parameter is mandatory when volumetype is set to GPSSD2 and cannot be configured when volume_type is set to other values." - description: "disk field description" - PersonalityInfo: - type: "object" - required: - - "content" - - "path" - properties: - path: - type: "string" - description: "Specifies the path of the injected file.For Linux OSs, specify the path, for example, /etc/foo.txt, for storing the injected file.For Windows, the injected file is automatically stored in the root directory of drive C. You only need to specify the file name, for example, foo. The file name contains only letters and digits." - content: - type: "string" - description: "Specifies the content of the injected file.The value must be the information after the content of the injected file is encoded using Base64." - description: "personality field description" - PublicIp: - type: "object" - required: - - "eip" - properties: - eip: - description: "Specifies the EIP automatically assigned to the ECS." - $ref: "#/definitions/EipInfo" - description: "public_ip field description" - EipInfo: - type: "object" - required: - - "bandwidth" - - "ip_type" - properties: - ip_type: - type: "string" - description: |- - Specifies the EIP type. - - Enumerated values of the IP address type: - - 5_bgp: indicates the dynamic BGP. - 5_sbgp: indicates the static BGP. - 5_telcom: indicates China Telecom. - 5_union: indicates China Unicom. - enum: - - "5_bgp" - - "5_sbgp" - - "5_telcom" - - "5_union" - bandwidth: - description: "Specifies the bandwidth of an IP address." - $ref: "#/definitions/BandwidthInfo" - description: "eip field description" - BandwidthInfo: - type: "object" - required: - - "share_type" - properties: - size: - type: "integer" - description: "Specifies the bandwidth (Mbit/s). The value range for bandwidth billed by duration is 1 to 2000 and that for bandwidth billed by traffic is 1 to 300.NOTE:If share_type is set to PER, this parameter is mandatory. If share_type is set to WHOLE, this parameter is invalid.The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.The minimum unit for bandwidth varies depending on the bandwidth range.The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included).The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).The minimum unit is 500 Mbit/s if the allowed bandwidth size is greater than 1000 Mbit/s." - minimum: 1 - maximum: 300 - share_type: - type: "string" - description: |- - Specifies the bandwidth sharing type. - - Enumerated values of the sharing type: - - PER: dedicated - WHOLE: shared - enum: - - "PER" - - "WHOLE" - charging_mode: - type: "string" - description: "Specifies the bandwidth billing mode.The options are as follows:bandwidth: billed by bandwidth.traffic: billed by traffic.If the parameter value is out of the preceding options, creating the ECS will fail.NOTE:If share_type is set to PER, this parameter is mandatory.If share_type is set to WHOLE, this parameter is invalid." - enum: - - "bandwidth" - - "traffic" - id: - type: "string" - description: "Specifies the bandwidth ID. When using a shared bandwidth, you can select an existing shared bandwidth to create an EIP.NOTE:If share_type is set to PER, this parameter is invalid.If share_type is set to WHOLE, this parameter is mandatory." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "bandwidth field description" - SecurityGroups: - type: "object" - required: - - "id" - properties: - id: - type: "string" - example: "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" - description: "Specifies the ID of the security group." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "security_groups field description" - ScalingConfigId: - type: "object" - properties: - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - ScalingConfigListResult: - type: "object" - properties: - total_number: - type: "integer" - description: "Specifies the total number of query records." - minimum: 0 - maximum: 100 - start_number: - type: "integer" - description: "Specifies the start line number." - limit: - type: "integer" - description: "Specifies the number of query records." - minimum: 0 - maximum: 100 - scaling_configurations: - type: "array" - description: "Specifies the AS configuration list." - items: - $ref: "#/definitions/ScalingConfiguration" - description: "Response parameters" - ScalingConfiguration: - type: "object" - properties: - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID. This parameter is globally unique." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenant: - type: "string" - description: "Specifies the tenant ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_configuration_name: - type: "string" - example: "config_name_1" - description: "Specifies the AS configuration name." - instance_config: - description: "Specifies the information about instance configurations." - $ref: "#/definitions/InstanceConfigResult" - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when AS configurations are created. The time format complies with UTC." - scaling_group_id: - type: "string" - description: "Specifies the ID of the AS group to which the AS configuration is bound." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "scaling_configurations field description" - InstanceConfigResult: - type: "object" - properties: - flavorRef: - type: "string" - description: "Specifies the ECS flavor ID." - imageRef: - type: "string" - description: "Specifies the image ID. It is same as image_id." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - disk: - type: "array" - description: "Specifies the disk group information." - items: - $ref: "#/definitions/DiskResult" - key_name: - type: "string" - description: "Specifies the name of the SSH key pair used to log in to the ECS." - minLength: 1 - maxLength: 32 - key_fingerprint: - type: "string" - description: "Specifies the fingerprint of the SSH key pair used to log in to the ECS." - instance_name: - type: "string" - description: "This parameter is reserved." - instance_id: - type: "string" - description: "This parameter is reserved." - adminPass: - type: "string" - description: "This parameter is reserved." - personality: - type: "array" - description: "Specifies information about the injected file." - items: - $ref: "#/definitions/PersonalityResult" - public_ip: - description: "Specifies the EIP of the ECS." - $ref: "#/definitions/PublicipResult" - user_data: - type: "string" - description: "Specifies the Cloud-Init user data, which is encoded using Base64." - metadata: - description: "Specifies the ECS metadata." - $ref: "#/definitions/VmMetaData" - security_groups: - type: "array" - description: "Specifies the security group information." - items: - $ref: "#/definitions/SecurityGroups" - server_group_id: - type: "string" - description: "Specifies the ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenancy: - type: "string" - description: "Specifies that ECSs are created on DeHs." - dedicated_host_id: - type: "string" - description: "Specifies the ID of a DeH." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - market_type: - type: "string" - description: "Specifies a billing mode for an ECS, which can be spot pricing or pay-per-use." - multi_flavor_priority_policy: - type: "string" - description: "Specifies the priority policy used when there are multiple flavors and instances to be created using an AS configuration." - description: "instance_config field description" - DiskResult: - type: "object" - properties: - size: - type: "integer" - description: "Specifies the disk size. The unit is GB." - volume_type: - type: "string" - description: "Specifies the disk type." - enum: - - "SATA" - - "SAS" - - "SSD" - - "co-pl" - - "uh-11" - - "GPSSD2" - - "ESSD2" - disk_type: - type: "string" - description: "Specifies whether the disk is a system disk or a data disk. DATA indicates a data disk. SYS indicates a system disk." - enum: - - "SYS" - - "DATA" - dedicated_storage_id: - type: "string" - description: "Specifies the ID of the DSS device for the disk." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - data_disk_image_id: - type: "string" - description: "Specifies the ID of the data disk image for creating a data disk." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - snapshot_id: - type: "string" - description: "Specifies the disk backup snapshot ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - metadata: - description: "Specifies the metadata for creating disks." - $ref: "#/definitions/MetaData" - iops: - type: "integer" - format: "int32" - description: "Specifies the IOPS configured for an EVS disk." - throughput: - type: "integer" - format: "int32" - description: "Specifies the throughput of an EVS disk." - description: "disk field description" - PersonalityResult: - type: "object" - properties: - path: - type: "string" - description: "Specifies the path of the injected file." - content: - type: "string" - description: "Specifies the content of the file to be injected. The file content is encoded using Base64." - description: "personality field description" - PublicipResult: - type: "object" - properties: - eip: - description: "Specifies the automatically assigned EIP." - $ref: "#/definitions/EipResult" - description: "public_ip field description" - EipResult: - type: "object" - properties: - ip_type: - type: "string" - description: "Specifies the IP address type." - enum: - - "5_bgp" - - "5_sbgp" - - "5_telcom" - - "5_union" - bandwidth: - description: "Specifies the bandwidth of an IP address." - $ref: "#/definitions/BandwidthResult" - description: "eip field description" - BandwidthResult: - type: "object" - properties: - size: - type: "integer" - description: "Specifies the bandwidth (Mbit/s)." - minimum: 1 - maximum: 300 - share_type: - type: "string" - description: |- - Specifies the bandwidth sharing type. - - Enumerated values of the sharing type: - - PER: dedicated - WHOLE: shared - enum: - - "PER" - - "WHOLE" - charging_mode: - type: "string" - description: |- - Specifies the bandwidth billing mode. - - traffic: billed by traffic. - enum: - - "bandwidth" - - "traffic" - id: - type: "string" - description: "Specifies the bandwidth ID. You can specify a shared bandwidth when applying for an EIP with the bandwidth whose type is set to WHOLE." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "bandwidth field description" - QueryScalingConfigResult: - type: "object" - properties: - scaling_configuration: - description: "Provides AS configuration details." - $ref: "#/definitions/ScalingConfiguration" - description: "Response parameters" - BatchDeleteScalingConfigOption: - type: "object" - required: - - "scaling_configuration_id" - properties: - scaling_configuration_id: - type: "array" - description: "Specifies the AS configuration ID" - items: - type: "string" - description: "Request parameters" - MetaData: - type: "object" - properties: - __system__encrypted: - type: "string" - description: "Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled).If this parameter does not exist, the disk will not be encrypted by default.NOTE:System disk encryption is not supported." - __system__cmkid: - type: "string" - description: "Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.NOTE:System disk encryption is not supported.For details about how to obtain the CMK ID, see Querying the List of CMKs(https://support.huaweicloud.com/intl/en-us/api-dew/ListKeys.html)." - description: "metadata Field Description for Creating Disks" - VmMetaData: - type: "object" - properties: - admin_pass: - type: "string" - description: "Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator.Password complexity requirements:Consists of 8 to 26 characters.Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?The password cannot contain the username or the username in reversed order.The Windows ECS password cannot contain the username, the username in reversed order, or more than two consecutive characters in the username." - description: "metadata field description" - UpdateScalingConfigOption: - type: "object" - required: - - "instance_config" - properties: - instance_config: - $ref: "#/definitions/UpdateInstanceConfig" - UpdateInstanceConfig: - type: "object" - required: - - "imageRef" - properties: - imageRef: - type: "string" - description: "imageID" - ScalingGroupId: - type: "object" - properties: - scaling_group_id: - type: "string" - example: "a8327883-6b07-4497-9c61-68d03ee193a1" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - CreateScalingGroupOption: - type: "object" - required: - - "networks" - - "scaling_configuration_id" - - "scaling_group_name" - - "vpc_id" - properties: - scaling_group_name: - type: "string" - description: "Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - desire_instance_number: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances. The default value is the minimum number of instances.The value ranges from the minimum number of instances to the maximum number of instances." - min_instance_number: - type: "integer" - format: "int32" - description: "Specifies the minimum number of instances. The default value is 0." - max_instance_number: - type: "integer" - format: "int32" - description: "Specifies the maximum number of instances. The default value is 0." - cool_down_time: - type: "integer" - format: "int32" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.After a scaling action is triggered, the system starts the cooldown period. During the cooldown period, scaling actions triggered by alarms will be denied. Scheduled, periodic, and manual scaling actions are not affected." - maximum: 86400 - lb_listener_id: - type: "string" - description: "Specifies the ID of a classic load balancer listener. You can bind up to six load balancer listeners. Separate listener IDs with commas (,). For details about how to obtain the listener ID, see Querying Load Balancers.This parameter is alternative to lbaas_listeners." - minLength: 1 - maxLength: 36 - lbaas_listeners: - type: "array" - description: "Specifies information about an enhanced load balancer. The system supports the binding of up to six load balancers. This parameter is in list data structure." - items: - $ref: "#/definitions/LbaasListeners" - available_zones: - type: "array" - description: "Specifies the AZ information. The instances added in a scaling action will be created in a specified AZ. If you do not specify an AZ, the system automatically specifies one." - items: - type: "string" - networks: - type: "array" - description: "Specifies network information. The system supports up to five subnets. The first subnet transferred serves as the primary NIC of the ECS by default. This parameter is in data structure." - items: - $ref: "#/definitions/Networks" - security_groups: - type: "array" - description: "Specifies the security group information. A maximum of one security group can be selected. This parameter is in data structure. For details, see Table 5.If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration." - items: - $ref: "#/definitions/SecurityGroup" - vpc_id: - type: "string" - description: "Specifies the VPC ID, which can be obtained using the API for querying VPCs. For details, see \"Querying VPCs\" in Virtual Private Network API Reference." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - health_periodic_audit_method: - type: "string" - description: "Specifies the health check method for instances in the AS group. The health check methods include ELB_AUDIT and NOVA_AUDIT. When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.ELB_AUDIT: indicates the ELB health check, which takes effect in an AS group with a listener.NOVA_AUDIT: indicates the ECS instance health check, which is the health check method delivered with AS." - enum: - - "ELB_AUDIT" - - "NOVA_AUDIT" - health_periodic_audit_time: - type: "integer" - format: "int32" - description: "Specifies the instance health check period. The value can be 1, 5, 15, 60, or 180 in the unit of minutes. If this parameter is not specified, the default value is 5.If the value is set to 0, health check is performed every 10 seconds." - health_periodic_audit_grace_period: - type: "integer" - format: "int32" - description: "Specifies the grace period for instance health check. The unit is second and the value ranges from 0 to 86400. The default value is 600.The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking the instance status only after the grace period ends.This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT." - maximum: 86400 - instance_terminate_policy: - type: "string" - description: "Specifies the instance removal policy.OLD_CONFIG_OLD_INSTANCE (default): The earlier-created instances based on the earlier-created AS configurations are removed first.OLD_CONFIG_NEW_INSTANCE: The later-created instances based on the earlier-created AS configurations are removed first.OLD_INSTANCE: The earlier-created instances are removed first.NEW_INSTANCE: The later-created instances are removed first." - enum: - - "OLD_CONFIG_OLD_INSTANCE" - - "OLD_CONFIG_NEW_INSTANCE" - - "OLD_INSTANCE" - - "NEW_INSTANCE" - notifications: - x-inner: true - type: "array" - description: "Specifies the notification mode.EMAIL refers to notification by email.This notification mode has been canceled. You are advised to configure the notification function for the AS group." - items: - type: "string" - delete_publicip: - type: "boolean" - description: "Specifies whether to delete the EIP bound to the ECS when deleting the ECS. The value can be true or false. The default value is false.true: deletes the EIP bound to the ECS when deleting the ECS. If the EIP is billed on a yearly/monthly basis, it will not be deleted when the ECS is deleted.false: only unbinds the EIP bound to the ECS when deleting the ECS." - delete_volume: - type: "boolean" - description: "Specifies whether to delete the data disks attached to the ECS when deleting the ECS. The value can be true or false. The default value is false.true: deletes the data disks attached to the ECS when deleting the ECS. If the data disks are billed a yearly/monthly basis, they will not be deleted when the ECS is deleted.false: only detaches the data disks attached to the ECS when deleting the ECS." - enterprise_project_id: - type: "string" - description: "Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.If the value is 0 or left blank, the AS group belongs to the default enterprise project.If the value is a UUID, the AS group belongs to the enterprise project corresponding to the UUID.. For how to obtain an enterprise project ID, see Querying Enterprise Projects(https://support.huaweicloud.com/intl/en-us/api-em/en-us_topic_0121230880.html).If an enterprise project is configured for an AS group, ECSs created in this AS group also belong to this enterprise project. Otherwise, the default enterprise project will be used.NOTE:For details about enterprise project features, see Enterprise Project Management User Guide(https://support.huaweicloud.com/intl/en-us/usermanual-em/en-us_topic_0131965280.html)." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - multi_az_priority_policy: - type: "string" - description: "Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.EQUILIBRIUM_DISTRIBUTE (default): When adjusting the number of instances, ensure that instances in each AZ in the available_zones list is evenly distributed. If instances cannot be added in the target AZ, select another AZ based on the PICK_FIRST policy.PICK_FIRST: When adjusting the number of instances, target AZs are determined in the order in the available_zones list." - enum: - - "EQUILIBRIUM_DISTRIBUTE" - - "PICK_FIRST" - iam_agency_name: - type: "string" - description: |- - Specifies the agency name, in 1 to 64 characters. - - iam_agency_name is not transferred if it is set to null. - iam_agency_name is transferred if it is left blank or has a value. - description: - type: "string" - description: "Specifies the description of the AS group. The value can contain 1 to 256 characters." - tags: - type: "array" - description: "Creates tags and adds them the AS group. Each AS group can have a maximum of 10 tags." - items: - $ref: "#/definitions/TagsSingleValue" - description: "Request parameters" - LbaasListeners: - type: "object" - required: - - "pool_id" - - "protocol_port" - - "weight" - properties: - pool_id: - type: "string" - description: "Specifies the backend ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - protocol_version: - type: "string" - description: "Specifies ip protocol version." - enum: - - "IPV4" - - "IPV6" - protocol_port: - type: "integer" - format: "int32" - description: "Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic. The port ID ranges from 1 to 65535." - minimum: 1 - maximum: 65535 - weight: - type: "integer" - format: "int32" - description: "Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener. The value of this parameter ranges from 0 to 100." - description: "lbaas_listeners field description" - Networks: - type: "object" - required: - - "id" - properties: - id: - type: "string" - example: "3cd35bca-5a10-416f-8994-f79169559870" - description: "Specifies the subnet ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - ipv6_enable: - type: "boolean" - description: "Specifies whether to support IPv6 addresses.true: indicates that the NIC supports IPv6 addresses.false: indicates that the NIC does not support IPv6 addresses. The default value is false." - ipv6_bandwidth: - description: "Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no shared IPv6 bandwidth is bound." - $ref: "#/definitions/Ipv6Bandwidth" - allowed_address_pairs: - type: "array" - description: "Specifies whether to allow the system to check the source and destination addresses." - items: - $ref: "#/definitions/AllowedAddressPair" - description: "networks field description" - Ipv6Bandwidth: - type: "object" - required: - - "id" - properties: - id: - type: "string" - description: "Specifies the ID of the shared bandwidth of an IPv6 address." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "ipv6_bandwidth field description" - SecurityGroup: - type: "object" - required: - - "id" - properties: - id: - type: "string" - example: "23b7b999-0a30-4b48-ae8f-ee201a88a6ab" - description: "Specifies the security group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "security_groups field description" - ScalingGroupsResult: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - description: "Specifies the start number of query records." - limit: - type: "integer" - format: "int32" - description: "Specifies the number of query records." - scaling_groups: - type: "array" - description: "Specifies the AS group list." - items: - $ref: "#/definitions/ScalingGroups" - description: "Response parameters" - ScalingGroups: - type: "object" - properties: - scaling_group_name: - type: "string" - description: "Specifies the name of the AS group." - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_status: - type: "string" - description: "Specifies the status of the AS group." - enum: - - "INSERVICE" - - "PAUSED" - - "ERROR" - - "DELETING" - - "FREEZED" - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_configuration_name: - type: "string" - description: "Specifies the AS configuration name." - minLength: 1 - maxLength: 64 - current_instance_number: - type: "integer" - format: "int32" - description: "Specifies the number of current instances in the AS group." - desire_instance_number: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances in the AS group." - min_instance_number: - type: "integer" - format: "int32" - description: "Specifies the minimum number of instances in the AS group." - max_instance_number: - type: "integer" - format: "int32" - description: "Specifies the maximum number of instances in the AS group." - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - lb_listener_id: - type: "string" - description: "Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,)." - minLength: 1 - maxLength: 32 - lbaas_listeners: - type: "array" - description: "Specifies enhanced load balancers." - items: - $ref: "#/definitions/LbaasListenersResult" - available_zones: - type: "array" - description: "Specifies the AZ information." - items: - type: "string" - networks: - type: "array" - description: "Specifies the network information." - items: - $ref: "#/definitions/NetworksResult" - security_groups: - type: "array" - description: "Specifies the security group information." - items: - $ref: "#/definitions/SecurityGroupsResult" - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS group was created. The time format complies with UTC." - vpc_id: - type: "string" - description: "Specifies the ID of the VPC to which the AS group belongs." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - detail: - type: "string" - description: "Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors." - is_scaling: - type: "boolean" - description: "Specifies the scaling flag of the AS group." - health_periodic_audit_method: - type: "string" - description: "Specifies the health check method." - enum: - - "ELB_AUDIT" - - "NOVA_AUDIT" - health_periodic_audit_time: - type: "integer" - format: "int32" - description: "Specifies the health check interval." - health_periodic_audit_grace_period: - type: "integer" - format: "int32" - description: "Specifies the grace period for health check." - maximum: 86400 - instance_terminate_policy: - type: "string" - description: "Specifies the instance removal policy." - enum: - - "OLD_CONFIG_OLD_INSTANCE" - - "OLD_CONFIG_NEW_INSTANCE" - - "OLD_INSTANCE" - - "NEW_INSTANCE" - notifications: - x-inner: true - type: "array" - description: "Specifies the notification mode.EMAIL refers to notification by email.This notification mode has been canceled. You are advised to configure the notification function for the AS group. For details, see Notifications.(https://support.huaweicloud.com/intl/en-us/api-as/as_06_0800.html)" - items: - type: "string" - delete_publicip: - type: "boolean" - description: "Specifies whether to delete the EIP bound to the ECS when deleting the ECS." - delete_volume: - type: "boolean" - description: "Specifies whether to delete the data disks attached to the ECS when deleting the ECS." - cloud_location_id: - type: "string" - description: "This parameter is reserved." - enterprise_project_id: - type: "string" - description: "Specifies the enterprise project ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - activity_type: - type: "string" - description: "Specifies the type of the AS action." - multi_az_priority_policy: - type: "string" - description: "Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group." - iam_agency_name: - type: "string" - description: "Specifies the agency name." - description: - type: "string" - description: "Specifies the description of the AS group." - tags: - type: "array" - description: "Specifies the tags added to the AS group." - items: - $ref: "#/definitions/TagsSingleValue" - description: "scaling_groups field description" - LbaasListenersResult: - type: "object" - properties: - listener_id: - type: "string" - description: "Specifies the listener ID." - pool_id: - type: "string" - description: "Specifies the backend ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - protocol_version: - type: "string" - description: "Specifies ip protocol version." - enum: - - "IPV4" - - "IPV6" - protocol_port: - type: "integer" - format: "int32" - description: "Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic." - minimum: 1 - maximum: 65535 - weight: - type: "integer" - format: "int32" - description: "Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener." - description: "lbaas_listeners field description" - NetworksResult: - type: "object" - properties: - id: - type: "string" - example: "a8327883-6b07-4497-9c61-68d03ee193a" - description: "Specifies the subnet ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - ipv6_enable: - type: "boolean" - description: "Specifies whether to support IPv6 addresses. If this parameter is set to true, the NIC supports IPv6 addresses. The default value is false." - ipv6_bandwidth: - description: "Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no IPv6 shared bandwidth is bound." - $ref: "#/definitions/Ipv6Bandwidth" - allowed_address_pairs: - type: "array" - description: "Specifies whether to allow the system to check the source and destination addresses." - items: - $ref: "#/definitions/AllowedAddressPair" - description: "networks field description" - SecurityGroupsResult: - type: "object" - properties: - id: - type: "string" - example: "8a4b1d5b-0054-419f-84b1-5c8a59ebc829" - description: "Specifies the security group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "security_groups field description" - ScalingGroupResult: - type: "object" - properties: - scaling_group: - description: "Specifies details about the AS group." - $ref: "#/definitions/ScalingGroups" - description: "Response parameters" - UpdateScalingGroupOption: - type: "object" - properties: - scaling_group_name: - type: "string" - description: "Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - desire_instance_number: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances.The value ranges from the minimum number of instances to the maximum number of instances." - min_instance_number: - type: "integer" - format: "int32" - description: "Specifies the minimum number of instances." - max_instance_number: - type: "integer" - format: "int32" - description: "Specifies the maximum number of instances, which is greater than or equal to the minimum number of instances." - cool_down_time: - type: "integer" - format: "int32" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default." - maximum: 86400 - available_zones: - type: "array" - description: "Specifies the AZ information. The instances added in a scaling action will be created in a specified AZ. If you do not specify an AZ, the system automatically specifies one.For details, see Regions and Endpoints.You can change the AZ of an AS group only when no scaling action is being performed in the group." - items: - type: "string" - networks: - type: "array" - description: "Specifies network information. You can select up to five subnets. The first subnet you select is used by the primary NICs of ECSs by default. The value of this parameter can be changed only when all the following conditions are met:No scaling actions are triggered in the AS group.The number of instances in the AS group is 0.The AS group is not in service." - items: - $ref: "#/definitions/Networks" - security_groups: - type: "array" - description: "Specifies the security group. A maximum of one security group can be selected. For how to obtain security group information, see Querying Security Groups. If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration. The value of this parameter can be changed only when all the following conditions are met:No scaling actions are triggered in the AS group.The number of instances in the AS group is 0.The AS group is not in service." - items: - $ref: "#/definitions/SecurityGroup" - lb_listener_id: - type: "string" - description: "Specifies the ID of a classic load balancer listener. The system supports the binding of up to six load balancer listeners, the IDs of which are separated using a comma (,). For details about how to obtain the listener ID, see Querying Load Balancers.The value of this parameter can be changed only when all the following conditions are met:No scaling actions are triggered in the AS group.The number of instances in the AS group is 0.The AS group is not in service." - minLength: 1 - maxLength: 32 - lbaas_listeners: - type: "array" - description: "Specifies information about an enhanced load balancer. The system supports the binding of up to six load balancers. . For how to obtain information about an enhanced load balancer, see Querying Backend Server Groups." - items: - $ref: "#/definitions/LbaasListeners" - health_periodic_audit_method: - type: "string" - description: "Specifies the health check method for instances in the AS group. The health check methods include ELB_AUDIT and NOVA_AUDIT. When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.ELB_AUDIT: indicates the ELB health check, which takes effect in an AS group with a listener.NOVA_AUDIT: indicates the ECS health check, which is the health check method delivered with AS." - enum: - - "ELB_AUDIT" - - "NOVA_AUDIT" - health_periodic_audit_time: - type: "integer" - format: "int32" - description: "Specifies the health check period for the instances in the AS group. The value can be 1, 5, 15, 60, or 180 in the unit of minutes.If the value is set to 0, health check is performed every 10 seconds." - health_periodic_audit_grace_period: - type: "integer" - format: "int32" - description: "Specifies the grace period for instance health check. The unit is second and value range is 0-86400. The default value is 600.The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking the instance status only after the grace period ends.This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT." - maximum: 86400 - instance_terminate_policy: - type: "string" - description: "Specifies the instance removal policy.OLD_CONFIG_OLD_INSTANCE (default): The earlier-created instances based on the earlier-created AS configurations are removed first.OLD_CONFIG_NEW_INSTANCE: The later-created instances based on the earlier-created AS configurations are removed first.OLD_INSTANCE: The earlier-created instances are removed first.NEW_INSTANCE: The later-created instances are removed first." - enum: - - "OLD_CONFIG_OLD_INSTANCE" - - "OLD_CONFIG_NEW_INSTANCE" - - "OLD_INSTANCE" - - "NEW_INSTANCE" - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS configurations." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - notifications: - x-inner: true - type: "array" - description: "Specifies the notification mode.EMAIL refers to notification by email.This notification mode has been canceled. You are advised to configure the notification function for the AS group. For details, see Notifications." - items: - type: "string" - delete_publicip: - type: "boolean" - description: "Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, set this parameter to false. Then, the system only unbinds the EIP from the ECS and reserves the EIP.true: deletes the EIP bound to the ECS when deleting the ECS. If the EIP is billed on a yearly/monthly basis, it will not be deleted when the ECS is deleted.false: only unbinds the EIP bound to the ECS when deleting the ECS." - delete_volume: - type: "boolean" - description: "Specifies whether to delete the data disks attached to the ECS when deleting the ECS. The value can be true or false. The default value is false.true: deletes the data disks attached to the ECS when deleting the ECS. If the data disks are billed a yearly/monthly basis, they will not be deleted when the ECS is deleted.false: only detaches the data disks attached to the ECS when deleting the ECS." - enterprise_project_id: - type: "string" - description: "Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.If the value is 0 or left blank, the AS group belongs to the default enterprise project.If the value is a UUID, the AS group belongs to the enterprise project corresponding to the UUID.. For how to obtain an enterprise project ID, see Querying Enterprise Projects(https://support.huaweicloud.com/intl/en-us/api-em/en-us_topic_0121230880.html).If an enterprise project is configured for an AS group, ECSs created in this AS group also belong to this enterprise project. Otherwise, the default enterprise project will be used.NOTE:For details about enterprise project features, see Enterprise Project Management Service(https://support.huaweicloud.com/intl/en-us/usermanual-em/en-us_topic_0131965280.html)." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - multi_az_priority_policy: - type: "string" - description: "Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.EQUILIBRIUM_DISTRIBUTE (default): When adjusting the number of instances, ensure that instances in each AZ in the available_zones list is evenly distributed. If instances cannot be added in the target AZ, select another AZ based on the PICK_FIRST policy.PICK_FIRST: When adjusting the number of instances, target AZs are determined in the order in the available_zones list." - iam_agency_name: - type: "string" - description: "Specifies the agency name, in 1 to 64 characters.If iam_agency_name is set to null, you do not need to modify it.If iam_agency_name is left blank or has a value, you need to modify it." - description: - type: "string" - description: "Specifies the description of the AS group. The value can contain 1 to 256 characters." - description: "Request parameters" - ResumeScalingGroupOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies a flag for enabling or disabling an AS group. - - resume: enables the AS group. - pause: disables the AS group. - enum: - - "resume" - description: "Request parameters" - PauseScalingGroupOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies a flag for enabling or disabling an AS group. - - resume: enables the AS group. - pause: disables the AS group. - enum: - - "pause" - description: "Request parameters" - AllowedAddressPair: - type: "object" - properties: - ip_address: - type: "string" - description: "Specifies whether to allow the system to check the source and destination addresses.This function is enabled by default. This parameter cannot be left empty.To disable this function, set the value to 1.1.1.1/0.To enable this function, set a value other than 1.1.1.1/0." - description: "allowed_address_pairs field description" - CreateScalingPolicyOption: - type: "object" - required: - - "scaling_group_id" - - "scaling_policy_name" - - "scaling_policy_type" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_group_id: - type: "string" - description: "Specifies the AS group ID, which can be obtained using the API for querying AS groups." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - alarm_id: - type: "string" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you create an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV1" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default." - maximum: 86400 - description: "Request parameters" - ScalingPolicyActionV1: - type: "object" - properties: - operation: - type: "string" - example: "ADD" - description: "Specifies the operation to be performed. The default operation is ADD.ADD: adds specified number of instances to the AS group.REMOVE/REDUCE: removes or reduces specified number of instances from the AS group.SET: sets the number of instances in the AS group." - enum: - - "ADD" - - "REMOVE" - - "REDUCE" - - "SET" - instance_number: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the number of instances to be operated. The default number is 1. The value range is as follows for a default quota:If operation is set to SET, the value ranges from 0 to 300.If operation is set to ADD, REMOVE, or REDUCE, the value ranges from 1 to 300.NOTE:Either instance_number or instance_percentage is required." - instance_percentage: - type: "integer" - description: "Specifies the percentage of instances to be operated. You can increase, decrease, or set the number of instances in an AS group to the specified percentage of the current number of instances. If operation is set to ADD, REMOVE or REDUCE, the value is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.If neither instance_number nor instance_percentage is specified, the number of instances to be operated is 1.Either instance_number or instance_percentage is required." - minimum: 0 - maximum: 100 - description: "scaling_policy_action field description" - ScalingPolicyId: - type: "object" - properties: - scaling_policy_id: - type: "string" - example: "0h327883-324n-4dzd-9c61-68d03ee191dd" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - UpdateScalingPolicyOption: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - alarm_id: - type: "string" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you modify an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV1" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400." - maximum: 86400 - description: "Request parameters" - ScheduledPolicy: - type: "object" - required: - - "launch_time" - properties: - launch_time: - type: "string" - description: "Specifies the time when the scaling action is triggered. The time format complies with UTC.If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.If scaling_policy_type is set to RECURRENCE, the time format is hh:mm." - recurrence_type: - type: "string" - description: "Specifies the periodic triggering type. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.Daily: indicates that the scaling action is triggered once a day.Weekly: indicates that the scaling action is triggered once a week.Monthly: indicates that the scaling action is triggered once a month." - enum: - - "Daily" - - "Weekly" - - "Monthly" - recurrence_value: - type: "string" - description: "Specifies the day when a periodic scaling action is triggered. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.NOTE:When recurrence_type is set to Daily, this parameter does not take effect." - minLength: 1 - maxLength: 64 - start_time: - type: "string" - description: "Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The default value is the local time.The time format is YYYY-MM-DDThh:mmZ." - end_time: - type: "string" - description: "Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. This parameter is mandatory when scaling_policy_type is set to RECURRENCE. When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time.The time format is YYYY-MM-DDThh:mmZ." - description: "scheduled_policy field description" - ScalingV1Policy: - type: "object" - properties: - scaling_policy: - description: "Specifies details about the AS policy." - $ref: "#/definitions/ScalingV1PolicyDetail" - description: "Response parameters" - ScalingV1Policies: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_policies: - type: "array" - description: "Specifies scaling policies." - items: - $ref: "#/definitions/ScalingV1PolicyDetail" - description: "Response parameters" - ScalingV1PolicyDetail: - type: "object" - properties: - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV1" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - description: "scaling_policies field description" - BatchResumeScalingPoliciesOption: - type: "object" - required: - - "action" - - "scaling_policy_id" - properties: - scaling_policy_id: - type: "array" - description: "Specifies the AS policy ID." - items: - type: "string" - force_delete: - type: "string" - description: "Specifies whether to forcibly delete an AS policy. If the value is set to no, in-progress AS policies cannot be deleted. Options:no (default): indicates that the AS policy is not forcibly deleted.yes: indicates that the AS policy is forcibly deleted.This parameter is available only when action is set to delete." - enum: - - "no" - - "yes" - action: - type: "string" - description: "Specifies an action to be performed on AS policies in batches. The options are as follows:delete: deletes AS policies.resume: enables AS policies.pause: disables AS policies." - enum: - - "resume" - delete_alarm: - type: "string" - description: "Specifies whether to delete the alarm rule used by the alarm policy. The value can be yes or no (default).This parameter is available only when action is set to delete." - description: "Request parameters" - BatchDeleteScalingPoliciesOption: - type: "object" - required: - - "action" - - "scaling_policy_id" - properties: - scaling_policy_id: - type: "array" - description: "Specifies the AS policy ID." - items: - type: "string" - force_delete: - type: "string" - description: "Specifies whether to forcibly delete an AS policy. If the value is set to no, in-progress AS policies cannot be deleted. Options:no (default): indicates that the AS policy is not forcibly deleted.yes: indicates that the AS policy is forcibly deleted.This parameter is available only when action is set to delete." - enum: - - "no" - - "yes" - action: - type: "string" - description: "Specifies an action to be performed on AS policies in batches. The options are as follows:delete: deletes AS policies.resume: enables AS policies.pause: disables AS policies." - enum: - - "delete" - delete_alarm: - type: "string" - description: "Specifies whether to delete the alarm rule used by the alarm policy. The value can be yes or no (default).This parameter is available only when action is set to delete." - description: "Request parameters" - BatchPauseScalingPoliciesOption: - type: "object" - required: - - "action" - - "scaling_policy_id" - properties: - scaling_policy_id: - type: "array" - description: "Specifies the AS policy ID." - items: - type: "string" - force_delete: - type: "string" - description: "Specifies whether to forcibly delete an AS policy. If the value is set to no, in-progress AS policies cannot be deleted. Options:no (default): indicates that the AS policy is not forcibly deleted.yes: indicates that the AS policy is forcibly deleted.This parameter is available only when action is set to delete." - enum: - - "no" - - "yes" - action: - type: "string" - description: "Specifies an action to be performed on AS policies in batches. The options are as follows:delete: deletes AS policies.resume: enables AS policies.pause: disables AS policies." - enum: - - "pause" - delete_alarm: - type: "string" - description: "Specifies whether to delete the alarm rule used by the alarm policy. The value can be yes or no (default).This parameter is available only when action is set to delete." - description: "Request parameters" - ExecuteScalingPolicyOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies the operation for an AS policy. - - execute: immediately executes the AS policy. - resume: enables the AS group. - pause: disables the AS group. - enum: - - "execute" - description: "Request parameters" - ResumeScalingPolicyOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies the operation for an AS policy. - - execute: immediately executes the AS policy. - resume: enables the AS group. - pause: disables the AS group. - enum: - - "resume" - description: "Request parameters" - PauseScalingPolicyOption: - type: "object" - required: - - "action" - properties: - action: - type: "string" - description: |- - Specifies the operation for an AS policy. - - execute: immediately executes the AS policy. - resume: enables the AS group. - pause: disables the AS group. - enum: - - "pause" - description: "Request parameters" - CreateScalingPolicyV2Option: - type: "object" - required: - - "scaling_policy_name" - - "scaling_policy_type" - - "scaling_resource_id" - - "scaling_resource_type" - properties: - scaling_policy_name: - type: "string" - example: "hth_aspolicy_1" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_resource_id: - type: "string" - example: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - description: "Specifies the scaling resource ID, which is the unique ID of an AS group or bandwidth.If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the unique AS group ID.If scaling_resource_type is set to BANDWIDTH, this parameter indicates the unique bandwidth ID.NOTE:AS cannot scale yearly/monthly bandwidths." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - example: "BANDWIDTH" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - scaling_policy_type: - type: "string" - example: "ALARM" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically.INTERVAL_ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by a refined scaling policy." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - example: "al1513822380493GvlJKZwA8" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you create an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - description: "Specifies the scaling actiong of the AS interval alarm." - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - example: 900 - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default." - maximum: 86400 - description: - type: "string" - description: "Specifies the description of the AS policy. The value can contain 1 to 256 characters." - description: "Request parameters" - ScalingPolicyActionV2: - type: "object" - properties: - operation: - type: "string" - example: "ADD" - description: "Specifies the operation to be performed. The default operation is ADD.If scaling_resource_type is set to SCALING_GROUP, the following operations are supported:ADD: indicates adding instances.REMOVE/REDUCE: indicates removing or reducing instances.SET: indicates setting the number of instances to a specified value.If scaling_resource_type is set to BANDWIDTH, the following operations are supported:ADD: indicates adding instances.REDUCE: indicates reducing instances.SET: indicates setting the number of instances to a specified value." - enum: - - "ADD" - - "REMOVE" - - "REDUCE" - - "SET" - size: - type: "integer" - example: 1 - description: "Specifies the operation size. The value is an integer from 0 to 300. The default value is 1. This parameter can be set to 0 only when operation is set to SET.If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the number of instances. The value is an integer from 0 to 300 and the default value is 1.If scaling_resource_type is set to BANDWIDTH, this parameter indicates the bandwidth (Mbit/s). The value is an integer from 1 to 300 and the default value is 1.If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set." - minimum: 0 - maximum: 300 - percentage: - type: "integer" - description: "Specifies the percentage of instances to be operated. If operation is set to ADD, REMOVE, or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. If neither size nor percentage is set, the default value of size is 1.If scaling_resource_type is set to BANDWIDTH, percentage is unavailable." - minimum: 0 - maximum: 20000 - limits: - type: "integer" - format: "int32" - example: 10 - description: "Specifies the operation restrictions.If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.If operation is set to ADD, this parameter indicates the maximum bandwidth allowed.If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed." - description: "scaling_policy_action field description" - UpdateScalingV2PolicyOption: - type: "object" - properties: - scaling_policy_name: - type: "string" - example: "hth_aspolicy_1\"" - description: "Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scaling_resource_id: - type: "string" - example: "8ade64b5-d685-40b8-8582-4ce306ea37a6" - description: "Specifies the scaling resource ID, which is the ID of a unique AS group or bandwidth." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - example: "BANDWIDTH" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - scaling_policy_type: - type: "string" - example: "ALARM" - description: "Specifies the AS policy type.ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.After you modify an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference." - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - description: "Specifies the scaling actiong of the AS interval alarm." - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - example: 900 - description: "Specifies the cooldown period (in seconds). The value ranges from 0 to 86400." - maximum: 86400 - description: - type: "string" - description: "Specifies the description of the AS policy. The value can contain 1 to 256 characters." - description: "Request parameters" - ScalingV2Policy: - type: "object" - properties: - scaling_policy: - description: "Specifies details about the AS policy." - $ref: "#/definitions/ScalingV2PolicyDetail" - description: "Response parameters" - ScalingV2PolicyDetail: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - enum: - - "INSERVICE" - - "PAUSED" - - "EXECUTING" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - scheduled_policy: - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - meta_data: - description: "Provides additional information." - $ref: "#/definitions/ScalingPolicyV2MetaData" - description: - type: "string" - description: "Specifies the AS policy description." - description: "scaling_policy field description" - QueryScalingPolicyListV2Response: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 3 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_policies: - type: "array" - description: "Specifies AS policies." - items: - $ref: "#/definitions/ScalingPoliciesV2" - description: "Response parameters" - ScalingPoliciesV2: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - enum: - - "INSERVICE" - - "PAUSED" - - "EXECUTING" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or scheduled AS policy." - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - description: "Specifies the scaling action of the AS policy." - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - description: "Specifies the scaling actiong of the AS interval alarm." - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - meta_data: - description: "Provides additional information." - $ref: "#/definitions/ScalingPolicyV2MetaData" - description: - type: "string" - description: "Specifies the AS policy description." - description: "scaling_policies field description" - AllScalingPolicies: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 3 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_policies: - type: "array" - description: "Specifies AS policies." - items: - $ref: "#/definitions/ScalingAllPolicyDetail" - description: "Response parameters" - ScalingAllPolicyDetail: - type: "object" - properties: - scaling_policy_name: - type: "string" - description: "Specifies the AS policy name." - minLength: 1 - maxLength: 64 - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - policy_status: - type: "string" - description: |- - Specifies the AS policy status. - - INSERVICE: The AS policy is enabled. - PAUSED: The AS policy is disabled. - EXECUTING: The AS policy is being executed. - enum: - - "INSERVICE" - - "PAUSED" - - "EXECUTING" - scaling_policy_type: - type: "string" - description: "Specifies the AS policy type.ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id." - enum: - - "ALARM" - - "SCHEDULED" - - "RECURRENCE" - - "INTERVAL_ALARM" - alarm_id: - type: "string" - description: "Specifies the alarm ID." - minLength: 1 - maxLength: 64 - scheduled_policy: - $ref: "#/definitions/ScheduledPolicy" - scaling_policy_action: - $ref: "#/definitions/ScalingPolicyActionV2" - interval_alarm_actions: - type: "array" - items: - $ref: "#/definitions/IntervalAlarmActionsV2" - cool_down_time: - type: "integer" - description: "Specifies the cooldown period (s)." - maximum: 86400 - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when an AS policy was created. The time format complies with UTC." - meta_data: - description: "Provides additional information." - $ref: "#/definitions/ScalingPolicyV2MetaData" - description: - type: "string" - description: "Specifies the AS policy description." - description: "scaling_policies field description" - ScalingPolicyV2MetaData: - type: "object" - properties: - metadata_bandwidth_share_type: - type: "string" - description: "Specifies the bandwidth sharing type in the bandwidth scaling policy." - metadata_eip_id: - type: "string" - description: "Specifies the EIP ID for the bandwidth in the bandwidth scaling policy." - metadata_eip_address: - type: "string" - description: "Specifies the EIP for the bandwidth in the bandwidth scaling policy." - description: "meta_data field description" - IntervalAlarmActionsV2: - type: "object" - properties: - operation: - type: "string" - example: "ADD" - description: |- - Specifies the operation to be performed. The default operation is ADD. - If scaling_resource_type is set to SCALING_GROUP, the following operations are supported: - ADD: indicates adding instances. - REMOVE/REDUCE: indicates removing or reducing instances. - SET: indicates setting the number of instances to a specified value. - If scaling_resource_type is set to BANDWIDTH, the following operations are supported: - ADD: indicates adding instances. - REDUCE: indicates reducing instances. - SET: indicates setting the number of instances to a specified value. - enum: - - "ADD" - - "REMOVE" - - "REDUCE" - - "SET" - limits: - type: "integer" - format: "int32" - example: 10 - description: |- - Specifies the operation restrictions. - - If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s. - - If operation is set to ADD, this parameter indicates the maximum bandwidth allowed. - If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed. - size: - type: "integer" - format: "int32" - example: 1 - description: |- - Specifies the operation size. The value is an integer from 0 to 300. The default value is 1. This parameter can be set to 0 only when operation is set to SET. - - If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the number of instances. The value is an integer from 0 to 300 and the default value is 1. - If scaling_resource_type is set to BANDWIDTH, this parameter indicates the bandwidth (Mbit/s). The value is an integer from 1 to 300 and the default value is 1. - If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. - minimum: 0 - maximum: 300 - lower_bound: - type: "number" - format: "double" - upper_bound: - type: "number" - format: "double" - percentage: - type: "integer" - format: "int32" - description: "Specifies the percentage of instances to be operated. If operation is set to ADD, REMOVE, or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000. If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. If neither size nor percentage is set, the default value of size is 1. If scaling_resource_type is set to BANDWIDTH, percentage is unavailable." - description: "Operation alarm Interval" - PolicyExecuteLogs: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the total number of query records." - minimum: 0 - maximum: 32768 - start_number: - type: "integer" - example: 0 - description: "Specifies the start line number." - minimum: 0 - maximum: 32768 - limit: - type: "integer" - example: 10 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 32768 - scaling_policy_execute_log: - type: "array" - description: "Specifies the AS policy execution logs." - items: - $ref: "#/definitions/ScalingPolicyExecuteLogList" - description: "Response parameters" - ScalingPolicyExecuteLogList: - type: "object" - properties: - status: - type: "string" - description: |- - Specifies the AS policy execution status. - - SUCCESS: The AS policy has been executed. - FAIL: Executing the AS policy failed. - EXECUTING: The AS policy is being executed. - enum: - - "SUCCESS" - - "FAIL" - - "EXECUTING" - failed_reason: - type: "string" - description: "Specifies the AS policy execution failure." - execute_type: - type: "string" - description: |- - Specifies the AS policy execution type. - - SCHEDULED: automatically triggered at a specified time point - RECURRENCE: automatically triggered at a specified time period - ALARM: alarm-triggered - MANUAL: manually triggered - INTERVAL_ALARM: automatically triggered by a refined scaling policy - enum: - - "SCHEDULE" - - "RECURRENCE" - - "ALARM" - - "MANUAL" - execute_time: - type: "string" - description: "Specifies the time when an AS policy was executed. The time format complies with UTC." - id: - type: "string" - description: "Specifies the ID of an AS policy execution log." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - tenant_id: - type: "string" - description: "Specifies the project ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_policy_id: - type: "string" - description: "Specifies the AS policy ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_resource_type: - type: "string" - description: |- - Specifies the scaling resource type. - - AS group: SCALING_GROUP - Bandwidth: BANDWIDTH - enum: - - "SCALING_GROUP" - - "BANDWIDTH" - scaling_resource_id: - type: "string" - description: "Specifies the scaling resource ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - old_value: - type: "string" - description: "Specifies the source value." - desire_value: - type: "string" - description: "Specifies the target value." - limit_value: - type: "string" - description: "Specifies the operation restrictions.If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.In this case:If operation is set to ADD, this parameter indicates the maximum bandwidth allowed.If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed." - type: - type: "string" - description: |- - Specifies the AS policy execution type. - - ADD: indicates adding instances. - REMOVE: indicates reducing instances. - SET: indicates setting the number of instances to a specified value. - enum: - - "ADD" - - "REMOVE" - - "SET" - job_records: - type: "array" - description: "Specifies the tasks contained in a scaling action based on an AS policy." - items: - $ref: "#/definitions/JobRecords" - meta_data: - description: "Provides additional information." - $ref: "#/definitions/EipMetaData" - description: "scaling_policy_execute_log field description" - JobRecords: - type: "object" - properties: - job_name: - type: "string" - description: "Specifies the task name." - record_type: - type: "string" - description: |- - Specifies the record type. - - API: API calling type - MEG: message type - enum: - - "API" - - "MEG" - record_time: - type: "string" - description: "Specifies the record time." - request: - type: "string" - description: "Specifies the request body. This parameter is valid only if record_type is set to API." - response: - type: "string" - description: "Specifies the response body. This parameter is valid only if record_type is set to API." - code: - type: "string" - description: "Specifies the returned code. This parameter is valid only if record_type is set to API." - message: - type: "string" - description: "Specifies the message. This parameter is valid only if record_type is set to MEG." - job_status: - type: "string" - description: |- - Specifies the execution status of the task. - - SUCCESS: The task is successfully executed. - FAIL: The task failed to be executed. - enum: - - "SUCCESS" - - "FAIL" - description: "job_records field description" - EipMetaData: - type: "object" - properties: - metadata_bandwidth_share_type: - type: "string" - description: "Specifies the bandwidth sharing type in the bandwidth scaling policy." - metadata_eip_id: - type: "string" - description: "Specifies the EIP ID for the bandwidth in the bandwidth scaling policy." - metadataeip_address: - type: "string" - description: "Specifies the EIP for the bandwidth in the bandwidth scaling policy." - description: "meta_data field description" - ScalingInstances: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 2 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - format: "int32" - example: 20 - description: "Specifies the maximum number of resources to be queried." - scaling_group_instances: - type: "array" - description: "Specifies details about the instances in the AS group." - items: - $ref: "#/definitions/ScalingGroupInstance" - description: "Response parameters" - ScalingGroupInstance: - type: "object" - properties: - instance_id: - type: "string" - description: "Specifies the instance ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - instance_name: - type: "string" - description: "Specifies the instance name." - minLength: 1 - maxLength: 64 - scaling_group_id: - type: "string" - description: "Specifies the ID of the AS group to which the instance belongs." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_name: - type: "string" - description: |- - Specifies the name of the AS group to which the instance belongs. - - Supports fuzzy search. - life_cycle_state: - type: "string" - description: "Specifies the instance lifecycle status in the AS group.INSERVICE: The instance is enabled.PENDING: The instance is being added to the AS group.PENDING_WAIT: The instance is waiting to be added to the AS group.REMOVING: The instance is being removed from the AS group.REMOVING_WAIT: The instance is waiting to be removed from the AS group.STANDBY: The instance is in standby state.ENTERING_STANDBY: The instance is entering the standby state." - enum: - - "INSERVICE" - - "PENDING" - - "REMOVING" - - "PENDING_WAIT" - - "REMOVING_WAIT" - health_status: - type: "string" - description: |- - Specifies the instance health status. - - INITIALIZING: The instance is being initialized. - NORMAL: The instance is functional. - ERROR: The instance is faulty. - enum: - - "NORMAL" - - "ERROR" - - "INITAILIZING" - scaling_configuration_name: - type: "string" - description: "Specifies the AS configuration name." - minLength: 1 - maxLength: 64 - scaling_configuration_id: - type: "string" - description: "Specifies the AS configuration ID.If the returned value is not empty, the instance is an ECS automatically created in a scaling action.If the returned value is empty, the instance is an ECS manually added to the AS group." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - create_time: - type: "string" - format: "date-time" - description: "Specifies the time when the instance is added to the AS group. The time format complies with UTC." - protect_from_scaling_down: - type: "boolean" - description: "Specifies the instance protection status." - description: "scaling_group_instances field description" - BatchAddInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "ADD" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchRemoveInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "REMOVE" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchProtectInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "PROTECT" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchUnprotectInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "UNPROTECT" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchEnterStandbyInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "ENTER_STANDBY" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - BatchExitStandByInstancesOption: - type: "object" - required: - - "action" - - "instances_id" - properties: - instances_id: - type: "array" - example: - - "instance_id_1" - - "instance_id_2" - description: "Specifies the ECS ID." - items: - type: "string" - instance_delete: - type: "string" - example: "yes" - description: "Specifies whether to delete an instance when it is removed from an AS group.Options:no (default): The instance will not be deleted.yes: The instance will be deleted.This parameter takes effect only when the action is set to REMOVE." - enum: - - "yes" - - "no" - action: - type: "string" - description: "Specifies an action to be performed on instances in batches. The options are as follows:ADD: adds instances to the AS group.REMOVE: removes instances from the AS group.PROTECT: enables instance protection.UNPROTECT: disables instance protection.ENTER_STANDBY: sets instances to standby mode.EXIT_STANDBY: cancels standby mode for instances." - enum: - - "EXIT_STANDBY" - instance_append: - type: "string" - description: "Specifies whether to add new instances when certain existing instances enter standby mode.Options:no (default): No new instances will be added.yes: New instances will be added.This parameter takes effect only when action is set to ENTER_STANDBY." - enum: - - "no" - - "yes" - description: "Request parameters" - CreateLifeCycleHookOption: - type: "object" - required: - - "lifecycle_hook_name" - - "lifecycle_hook_type" - - "notification_topic_urn" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 32 characters." - minLength: 1 - maxLength: 64 - lifecycle_hook_type: - type: "string" - description: "Specifies the lifecycle hook type. Options:INSTANCE_TERMINATING: The hook suspends the instance when the instance is terminated.INSTANCE_LAUNCHING: The hook suspends the instance when the instance is started." - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - description: "Specifies the default lifecycle hook callback operation. By default, this operation is performed when the timeout duration expires.ABANDONCONTINUENOTE:If an instance is starting, CONTINUE indicates that your customized operations are successful and the instance can be used. ABANDON indicates that your customized operations failed, and the instance will be terminated. In such a case, the scaling action fails, and you must create a new instance.If an instance is stopping, both ABANDON and CONTINUE allow instance termination. The difference between the two states is as follows: ABANDON stops other lifecycle hooks, but CONTINUE allows the completion of other lifecycle hooks.The default value of this parameter is ABANDON." - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration, which ranges from 60 to 86400 in the unit of second. The default value is 3600.By default, this parameter specifies the instance waiting duration. You can prolong the timeout duration or perform the CONTINUE or ABANDON operation before the timeout duration expires." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN.This parameter specifies a notification object for a lifecycle hook. When an instance is suspended by the lifecycle hook, the SMN service sends a notification to the object. This notification contains the basic instance information, your customized notification content, and the token for controlling lifecycle operations." - notification_metadata: - type: "string" - description: "Specifies a customized notification, which contains no more than 256 characters in length. The message cannot contain the following characters: <>&'()After a notification object is configured, the SMN service sends your customized notification to the object." - description: "Request parameters" - LifeCycleHookResult: - type: "object" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name." - minLength: 1 - maxLength: 64 - lifecycle_hook_type: - type: "string" - description: |- - Specifies the lifecycle hook type. - - INSTANCE_TERMINATING - INSTANCE_LAUNCHING - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - description: |- - Specifies the default lifecycle hook callback operation. - - ABANDON - CONTINUE - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration in the unit of second." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - notification_topic_name: - type: "string" - description: "Specifies the topic name in SMN." - minLength: 1 - maxLength: 64 - notification_metadata: - type: "string" - description: "Specifies the notification message." - create_time: - type: "string" - description: "Specifies the UTC-compliant time when the lifecycle hook is created." - description: "Response parameters" - QueryLifecycleHookListResult: - type: "object" - properties: - lifecycle_hooks: - type: "array" - description: "Specifies lifecycle hooks." - items: - $ref: "#/definitions/LifecycleHookList" - description: "Response parameters" - LifecycleHookList: - type: "object" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name." - minLength: 1 - maxLength: 64 - lifecycle_hook_type: - type: "string" - description: |- - Specifies the lifecycle hook type. - - INSTANCE_TERMINATING - INSTANCE_LAUNCHING - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - description: |- - Specifies the default lifecycle hook callback operation. - - ABANDON - CONTINUE - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration in the unit of second." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - notification_topic_name: - type: "string" - description: "Specifies the topic name in SMN." - minLength: 1 - maxLength: 64 - notification_metadata: - type: "string" - description: "Specifies the customized notification." - create_time: - type: "string" - description: "Specifies the time when the lifecycle hook is created. The time is UTC-compliant." - description: "lifecycle_hooks field description" - UpdateLifeCycleHookOption: - type: "object" - properties: - lifecycle_hook_type: - type: "string" - description: "Specifies the lifecycle hook type. Options:INSTANCE_TERMINATING: The hook suspends the instance when the instance is terminated.INSTANCE_LAUNCHING: The hook suspends the instance when the instance is started." - enum: - - "INSTANCE_TERMINATING" - - "INSTANCE_LAUNCHING" - default_result: - type: "string" - example: "CONTINUE" - description: "Specifies the default lifecycle hook callback operation. By default, this operation is performed when the timeout duration expires.ABANDONCONTINUENOTE:If an instance is starting, CONTINUE indicates that your customized operations are successful and the instance can be used. ABANDON indicates that your customized operations failed, and the instance will be terminated. In such a case, the scaling action fails, and you must create a new instance.If an instance is stopping, both ABANDON and CONTINUE allow instance termination. The difference between the two states is as follows: ABANDON stops other lifecycle hooks, but CONTINUE allows the completion of other lifecycle hooks.The default value of this parameter is ABANDON." - enum: - - "ABANDON" - - "CONTINUE" - default_timeout: - type: "integer" - description: "Specifies the lifecycle hook timeout duration, which ranges from 60 to 86400 in the unit of second. The default value is 3600.By default, this parameter specifies the instance waiting duration. You can prolong the timeout duration or perform the CONTINUE or ABANDON operation before the timeout duration expires." - minimum: 60 - maximum: 86400 - notification_topic_urn: - type: "string" - description: "Specifies a unique topic in SMN.This parameter specifies a notification object for a lifecycle hook. When an instance is suspended by the lifecycle hook, the SMN service sends a notification to the object. This notification contains the basic instance information, your customized notification content, and the token for controlling lifecycle operations." - notification_metadata: - type: "string" - description: "Specifies a customized notification, which contains no more than 256 characters in length. The message cannot contain the following characters: <>&'()After a notification object is configured, the SMN service sends your customized notification to the object." - description: "Modifying a Lifecycle Hook" - CallbackLifeCycleHookOption: - type: "object" - required: - - "lifecycle_action_result" - properties: - lifecycle_action_key: - type: "string" - example: "23880867-6288-4470-98a8-f8bda096b6c4" - description: "Specifies the lifecycle operation token, which is obtained by calling the API for querying instance suspension.When specifying a lifecycle callback object, this field is mandatory if the instance_id parameter is not used. If both this parameter and the instance_id parameter are used, preferentially use this parameter for callback." - instance_id: - type: "string" - description: "Specifies the instance ID.When a lifecycle callback object is specified, this parameter is mandatory if the lifecycle_action_key parameter is not used." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name.When a lifecycle callback object is specified, this parameter is mandatory if the lifecycle_action_key parameter is not used." - minLength: 1 - maxLength: 64 - lifecycle_action_result: - type: "string" - description: |- - Specifies the lifecycle callback action. - - ABANDON: terminates the instance. - CONTINUE: continues the instance. - EXTEND: extends the timeout duration, one hour each time. - enum: - - "ABANDON" - - "CONTINUE" - - "EXTEND" - description: "Request parameters" - InstanceListResult: - type: "object" - properties: - instance_hanging_info: - type: "array" - description: "Specifies lifecycle hook information about an AS instance." - items: - $ref: "#/definitions/InstanceHangingInfos" - description: "Response parameters" - InstanceHangingInfos: - type: "object" - properties: - lifecycle_hook_name: - type: "string" - description: "Specifies the lifecycle hook name." - minLength: 1 - maxLength: 64 - lifecycle_action_key: - type: "string" - description: "Specifies the lifecycle action key, which determines the lifecycle callback object." - instance_id: - type: "string" - description: "Specifies the AS instance ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - lifecycle_hook_status: - type: "string" - description: |- - Specifies the lifecycle hook status. - - HANGING: suspends the instance. - CONTINUE: continues the instance. - ABANDON: terminates the instance. - enum: - - "HANGING" - - "CONTINUE" - - "ABANDON" - timeout: - type: "string" - description: "Specifies the timeout duration in the format of \"YYYY-MM-DDThh:mm:ssZ\". The time is UTC-compliant." - default_result: - type: "string" - description: "Specifies the default lifecycle hook callback operation." - description: "instance_hanging_info field description" - CreateNotificationOption: - required: - - "topic_scene" - - "topic_urn" - properties: - topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - topic_scene: - type: "array" - description: "Specifies a notification scenario, which can be one of the following: SCALING_UP indicates that the capacity is expanded. SCALING_UP_FAIL indicates that the capacity expansion failed. SCALING_DOWN indicates that the capacity is reduced. SCALING_DOWN_FAIL indicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL indicates that an exception has occurred in the AS group." - items: - type: "string" - enum: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - description: "Notifications" - CreateNotificationResult: - type: "object" - properties: - topic_urn: - type: "string" - example: "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh" - description: "Specifies a unique topic in SMN." - topic_scene: - type: "array" - example: - - "SCALING_UP" - - "SCALING_UP_FAIL" - - "SCALING_DOWN" - - "SCALING_DOWN_FAIL" - - "SCALING_GROUP_ABNORMAL" - description: "Specifies a notification scenario, which can be one of the following: SCALING_UP indicates that the capacity is expanded. SCALING_UP_FAIL indicates that the capacity expansion failed. SCALING_DOWN indicates that the capacity is reduced. SCALING_DOWN_FAIL indicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL indicates that an exception has occurred in the AS group." - items: - type: "string" - topic_name: - type: "string" - example: "gsh" - description: "Specifies the topic name in SMN." - description: "Response parameters" - ListScalingNotificationsResult: - type: "object" - properties: - topics: - type: "array" - description: "Specifies the AS group notification list." - items: - $ref: "#/definitions/Topics" - description: "Response parameters" - Topics: - properties: - topic_urn: - type: "string" - description: "Specifies a unique topic in SMN." - topic_scene: - type: "array" - description: "Specifies a notification scenario, which can be one of the following: SCALING_UP indicates that the capacity is expanded. SCALING_UP_FAIL indicates that the capacity expansion failed. SCALING_DOWN indicates that the capacity is reduced. SCALING_DOWN_FAIL indicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL indicates that an exception has occurred in the AS group." - items: - type: "string" - topic_name: - type: "string" - description: "Specifies the topic name in SMN." - QuotaResult: - type: "object" - properties: - quotas: - description: "Specifies quota details." - $ref: "#/definitions/AllQuotas" - description: "Response parameters" - AllQuotas: - type: "object" - properties: - resources: - type: "array" - description: "Specifies resources." - items: - $ref: "#/definitions/AllResources" - description: "Response parameters" - AllResources: - type: "object" - properties: - type: - type: "string" - description: |- - Specifies the quota type. - - scaling_Group: AS group quota - scaling_Config: AS configuration quota - scaling_Policy: AS policy quota - scaling_Instance: instance quota - bandwidth_scaling_policy: bandwidth scaling policy quota - enum: - - "scaling_group" - - "scaling_config" - - "scaling_Policy" - - "scaling_Instance" - - "bandwidth_scaling_policy" - used: - type: "integer" - format: "int32" - description: "Specifies the used amount of the quota.When type is set to scaling_Policy or scaling_Instance, this parameter is reserved, and the system returns -1 as the parameter value. You can query the used quota of AS policies and AS instances in a specified AS group." - quota: - type: "integer" - format: "int32" - description: "Specifies the total quota." - max: - type: "integer" - format: "int32" - description: "Specifies the quota upper limit." - min: - type: "integer" - format: "int32" - description: "Specifies the quota lower limit." - description: "resources field description" - PolicyInstanceQuotaResult: - type: "object" - properties: - quotas: - description: "Specifies quota details." - $ref: "#/definitions/PolicyInstanceQuotas" - description: "Response parameters" - PolicyInstanceQuotas: - type: "object" - properties: - resources: - type: "array" - description: "Specifies resources." - items: - $ref: "#/definitions/PolicyInstanceResources" - description: "quotas field description" - PolicyInstanceResources: - type: "object" - properties: - type: - type: "string" - description: |- - Specifies the quota type. - - scaling_Policy: indicates AS policies. - scaling_Instance: indicates instances. - used: - type: "integer" - format: "int32" - description: "Specifies the used quota." - quota: - type: "integer" - format: "int32" - description: "Specifies the total quota." - max: - type: "integer" - format: "int32" - description: "Specifies the quota upper limit." - min: - type: "integer" - format: "int32" - description: "Specifies the quota lower limit." - description: "resources field description" - ScalingActivityLogs: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 2 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "Specifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_activity_log: - type: "array" - description: "Specifies scaling action logs." - items: - $ref: "#/definitions/ScalingActivityLogList" - description: "Response parameters" - ScalingActivityLogList: - type: "object" - properties: - status: - type: "string" - description: |- - Specifies the status of the scaling action. - - SUCCESS: The scaling action has been performed. - FAIL: Performing the scaling action failed. - DOING: The scaling action is being performed. - enum: - - "SUCCESS" - - "FAIL" - - "DOING" - start_time: - type: "string" - format: "date-time" - description: "Specifies the start time of the scaling action. The time format must comply with UTC." - end_time: - type: "string" - format: "date-time" - description: "Specifies the end time of the scaling action. The time format must comply with UTC." - id: - type: "string" - description: "Specifies the scaling action log ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - instance_removed_list: - type: "string" - description: "Specifies the names of the instances removed from the AS group after the scaling action is complete. The instance names are separated using commas (,)." - instance_deleted_list: - type: "string" - description: "Specifies the names of the instances removed and deleted from the AS group after the scaling action is complete. The instance names are separated using commas (,)." - instance_added_list: - type: "string" - description: "Specifies the names of the instances added to the AS group after the scaling action is complete. The instance names are separated using commas (,)." - scaling_value: - type: "integer" - format: "int32" - description: "Specifies the number of added or removed instances in the scaling action." - description: - type: "string" - description: "Specifies the description of the scaling action." - instance_value: - type: "integer" - format: "int32" - description: "Specifies the number of instances in the AS group." - desire_value: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances for the scaling action." - description: "scaling_activity_log field description" - ScalingActivityV2Logs: - type: "object" - properties: - total_number: - type: "integer" - format: "int32" - example: 2 - description: "Specifies the total number of query records." - start_number: - type: "integer" - format: "int32" - example: 0 - description: "Specifies the start line number." - limit: - type: "integer" - example: 20 - description: "pecifies the maximum number of resources to be queried." - minimum: 0 - maximum: 100 - scaling_activity_log: - type: "array" - description: "Specifies scaling action logs." - items: - $ref: "#/definitions/ScalingActivityLogV2" - description: "Response parameters" - ScalingActivityLogV2: - type: "object" - properties: - status: - type: "string" - description: |- - Specifies the status of the scaling action. - - SUCCESS: The scaling action has been performed. - FAIL: Performing the scaling action failed. - DOING: The scaling action is being performed. - enum: - - "SUCCESS" - - "FAIL" - - "DOING" - start_time: - type: "string" - format: "date-time" - description: "Specifies the start time of the scaling action. The time format must comply with UTC." - end_time: - type: "string" - format: "date-time" - description: "Specifies the end time of the scaling action. The time format must comply with UTC." - id: - type: "string" - description: "Specifies the scaling action log ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - instance_removed_list: - type: "array" - description: "Specifies names of the ECSs that are removed from the AS group in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - instance_deleted_list: - type: "array" - description: "Specifies names of the ECSs that are removed from the AS group and deleted in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - instance_added_list: - type: "array" - description: "Specifies names of the ECSs that are added to the AS group in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - instance_failed_list: - type: "array" - description: "Specifies the ECSs for which a scaling action fails." - items: - $ref: "#/definitions/ScalingInstance" - instance_standby_list: - type: "array" - description: "Specifies the ECSs that are set to standby mode or for which standby mode is canceled in a scaling action." - items: - $ref: "#/definitions/ScalingInstance" - scaling_value: - type: "integer" - format: "int32" - description: "Specifies the number of added or deleted instances during the scaling." - description: - type: "string" - description: "Specifies the description of the scaling action." - instance_value: - type: "integer" - format: "int32" - description: "Specifies the number of instances in the AS group." - desire_value: - type: "integer" - format: "int32" - description: "Specifies the expected number of instances for the scaling action." - lb_bind_success_list: - type: "array" - description: "Specifies the load balancers that are bound to the AS group." - items: - $ref: "#/definitions/ModifyLb" - lb_bind_failed_list: - type: "array" - description: "Specifies the load balancers that failed to be bound to the AS group." - items: - $ref: "#/definitions/ModifyLb" - lb_unbind_success_list: - type: "array" - description: "Specifies the load balancers that are unbound from the AS group." - items: - $ref: "#/definitions/ModifyLb" - lb_unbind_failed_list: - type: "array" - description: "Specifies the load balancers that failed to be unbound from the AS group." - items: - $ref: "#/definitions/ModifyLb" - type: - type: "string" - description: "Specifies the type of the scaling action." - description: "scaling_activity_log field description" - ScalingInstance: - type: "object" - properties: - instance_name: - type: "string" - description: "Specifies the ECS name." - minLength: 1 - maxLength: 64 - instance_id: - type: "string" - description: "Specifies the ECS ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - failed_reason: - type: "string" - description: "Specifies the cause of the instance scaling failure." - failed_details: - type: "string" - description: "Specifies details of the instance scaling failure." - instance_config: - type: "string" - description: "Specifies the information about instance configurations." - description: "scaling_instance field description" - ModifyLb: - type: "object" - properties: - lbaas_listener: - description: "Specifies information about an enhanced load balancer." - $ref: "#/definitions/LbaasListener" - listener: - type: "string" - description: "Specifies information about a classic load balancer." - failed_reason: - type: "string" - description: "Specifies the cause of a load balancer migration failure." - failed_details: - type: "string" - description: "Specifies the details of a load balancer migration failure." - description: "modify_lb field description" - LbaasListener: - type: "object" - properties: - listener_id: - type: "string" - description: "Specifies the listener ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - pool_id: - type: "string" - description: "Specifies the backend ECS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - protocol_port: - type: "integer" - description: "Specifies the backend protocol port, which is the port on which a backend ECS listens for traffic." - minimum: 1 - maximum: 65535 - weight: - type: "integer" - format: "int32" - description: "Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener." - description: "lbaas_listener field description" - ShowTagByTenantResult: - type: "object" - properties: - tags: - type: "array" - description: "Specifies tags" - items: - $ref: "#/definitions/TagsMultiValue" - description: "Response parameters" - QueryTagByResourceIdResult: - type: "object" - properties: - tags: - type: "array" - description: "Specifies tags." - items: - $ref: "#/definitions/TagsSingleValue" - sys_tags: - type: "array" - description: "Specifies system tags." - items: - $ref: "#/definitions/TagsSingleValue" - description: "Response parameters" - TagsSingleValue: - type: "object" - required: - - "key" - properties: - key: - type: "string" - description: "Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left blank (This parameter is not verified in the search process.) A maximum of 10 keys are allowed and the key cannot be left blank or an empty string. Each key must be unique." - value: - type: "string" - description: "Specifies tag values. A value contains a maximum of 43 Unicode characters. A key contains a maximum of 10 values. Each value of the same key must be unique." - description: "ResourceTag field description" - QueryTagsOption: - type: "object" - required: - - "action" - properties: - tags: - type: "array" - example: - - key: "key1" - values: - - "*value1" - - "value2" - description: "Specifies filter criteria with tags included. A maximum of 10 keys can be contained. The structure body must be complete." - items: - $ref: "#/definitions/TagsMultiValue" - tags_any: - type: "array" - example: - - key: "key1" - values: - - "value1" - - "value2" - description: "Specifies filter criteria with any tag included. A maximum of 10 keys can be contained." - items: - $ref: "#/definitions/TagsMultiValue" - not_tags: - type: "array" - example: - - key: "key1" - values: - - "*value1" - - "value2" - description: "Specifies filter criteria without tags included. A maximum of 10 keys can be contained." - items: - $ref: "#/definitions/TagsMultiValue" - not_tags_any: - type: "array" - example: - - key: "key1" - values: - - "value1" - - "value2" - description: "Specifies filter criteria without any tag included. A maximum of 10 keys can be contained." - items: - $ref: "#/definitions/TagsMultiValue" - limit: - type: "string" - example: "100" - description: "Specifies the maximum number of query records. The maximum value is 1,000, and the minimum value is 1.If action is set to count, this parameter is invalid.If action is set to filter, the default value is 1000." - marker: - type: "string" - description: "Marks the paging location (index position). You are advised to use the offset parameter to set the index position.Marks the paging location (resource ID or index location)." - action: - type: "string" - description: "Specifies the operation, which can be filter or count.filter: indicates that resources are filtered by tag and the resources meeting the search criteria are returned on pages.count: indicates that resources are searched by tag and the number of resources meeting the search criteria is returned." - enum: - - "filter" - - "count" - offset: - type: "string" - description: "Specifies the index position. The query starts from the next image indexed by this parameter. The value must be a non-negative number.You do not need to specify this parameter when querying resources on the first page. When you query resources on subsequent pages, set offset to the location returned in the response body for the previous query.If the action value is count, this parameter is invalid.If the action value is filter, the default value is 0." - matches: - type: "array" - example: - - key: "resource_name" - values: "resource1" - description: "Specifies fuzzy search." - items: - $ref: "#/definitions/Matches" - description: "Request parameters" - TagsMultiValue: - type: "object" - required: - - "key" - - "values" - properties: - key: - type: "string" - description: "Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left blank (This parameter is not verified in the search process.) A maximum of 10 keys are allowed and the key cannot be left blank or an empty string. Each key must be unique." - minLength: 1 - maxLength: 127 - values: - type: "array" - description: "Specifies tag values. A value contains a maximum of 43 Unicode characters. A key contains a maximum of 10 values. Each value of the same key must be unique." - items: - type: "string" - minLength: 0 - maxLength: 255 - Matches: - type: "object" - required: - - "key" - - "value" - properties: - key: - type: "string" - description: |- - Specifies the key based on which to query resources. - - The parameter value can only be resource_name. - minLength: 1 - maxLength: 127 - value: - type: "string" - description: "Specifies the value. The value is a fixed dictionary value. A value contains a maximum of 255 Unicode characters. If the value is an empty string or resource_id, exact match is used." - minLength: 1 - maxLength: 255 - QueryTagsResult: - type: "object" - properties: - resources: - type: "array" - description: "Specifies tag resources." - items: - $ref: "#/definitions/Resources" - total_count: - type: "integer" - example: 2 - description: "Specifies the total number of records. When action is set to count, only this parameter is returned. The values of resources and marker are not returned." - marker: - type: "string" - example: "2" - description: "Specifies the paging location identifier." - Resources: - type: "object" - properties: - resource_id: - type: "string" - description: "Specifies the resource ID." - resource_detail: - type: "string" - description: "Specifies the resource details." - tags: - type: "array" - description: "Specifies tags. If there is no tag, tags is taken as an empty array by default." - items: - $ref: "#/definitions/ResourceTags" - resource_name: - type: "string" - description: "Specifies the resource name. If there is no resource, this parameter is an empty string by default." - ResourceTags: - type: "object" - properties: - key: - type: "string" - description: "Specifies the tag key. It contains a maximum of 36 Unicode characters." - value: - type: "string" - description: "Specifies the tag value. It contains a maximum of 36 Unicode characters." - CreateTagsOption: - type: "object" - required: - - "action" - - "tags" - properties: - tags: - type: "array" - description: "Specifies the tag list. If action is set to delete, the tag structure cannot be missing, and the key cannot be left blank or an empty string." - items: - $ref: "#/definitions/TagsSingleValue" - action: - type: "string" - description: "Specifies the operation ID. The value is case-sensitive and can be any of the following:delete: indicates deleting a tag.create: indicates creating a tag. If the same key value already exists, it will be overwritten." - enum: - - "create" - description: "Request parameters" - DeleteTagsOption: - type: "object" - required: - - "action" - - "tags" - properties: - tags: - type: "array" - description: "Specifies the tag list. If action is set to delete, the tag structure cannot be missing, and the key cannot be left blank or an empty string." - items: - $ref: "#/definitions/TagsSingleValue" - action: - type: "string" - description: "Specifies the operation ID. The value is case-sensitive and can be any of the following:delete: indicates deleting a tag.create: indicates creating a tag. If the same key value already exists, it will be overwritten." - enum: - - "delete" - description: "Request parameters" - CreateScheduledTaskOption: - type: "object" - required: - - "instance_number" - - "name" - - "scheduled_policy" - properties: - name: - type: "string" - description: "Specifies the AS scheduled task name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or point-in-time AS policy." - $ref: "#/definitions/ScheduledTaskPolicy" - instance_number: - description: "Specifies the max and min count of instance for AS group." - $ref: "#/definitions/IntegerRange" - description: "Request parameters" - IntegerRange: - type: "object" - properties: - max: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the maximum of instances for AS group. NOTE: At least one of the max and min is required. If both max and min are specified, the min value should be less than or equal to the max value." - min: - type: "integer" - format: "int32" - example: 1 - description: "Specifies the minimum of instances for AS group. NOTE: At least one of the max and min is required. If both max and min are specified, the min value should be less than or equal to the max value." - desire: - type: "integer" - format: "int32" - description: "The max and min instance count of AS group." - ScheduledTaskId: - type: "object" - properties: - task_id: - type: "string" - example: "0h327883-324n-4dzd-9c61-68d03ee191dd" - description: "the AS scheduled task ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - description: "Response parameters" - UpdateScheduledTaskOption: - type: "object" - properties: - name: - type: "string" - description: "Specifies the AS scheduled task. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or point-in-time AS policy." - $ref: "#/definitions/ScheduledTaskPolicy" - instance_number: - description: "Specifies the max and min count of instance for AS group." - $ref: "#/definitions/IntegerRange" - description: "Request parameters" - ScheduledTaskPolicy: - type: "object" - required: - - "launch_time" - properties: - start_time: - type: "string" - description: "Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The default value is the local time. The time format is yyyy-MM-ddTHH:mmZ." - end_time: - type: "string" - description: "Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time. The time format is yyyy-MM-ddTHH:mmZ." - launch_time: - type: "string" - description: "Specifies the time when the scaling action is triggered. The time format complies with UTC. If recurrence_type is empty or null, the time format is yyyy-MM-ddTHH:mmZ. If recurrence_type is not empty, the time format is HH:mm." - recurrence_type: - type: "string" - description: "'Specifies the periodic triggering type. DAILY: indicates that the scaling action is triggered once a day. WEEKLY: indicates that the scaling action is triggered once a week. MONTHLY: indicates that the scaling action is triggered once a month.'" - enum: - - "DAILY" - - "WEEKLY" - - "MONTHLY" - recurrence_value: - type: "string" - description: "Specifies the day when a periodic scaling action is triggered. If recurrence_type is set to DAILY, the value is null, indicating that the scaling action is triggered once a day. If recurrence_type is set to WEEKLY, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5. If recurrence_type is set to MONTHLY, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28." - minLength: 1 - maxLength: 64 - description: "scheduled_policy field description" - PageInfo: - type: "object" - properties: - next_marker: - type: "string" - description: "Specifies the marker of next page." - minLength: 1 - maxLength: 64 - description: "page info" - ScheduledTasksResult: - type: "object" - properties: - page_info: - description: "Specifies the page info of the last record of query." - $ref: "#/definitions/PageInfo" - scheduled_tasks: - type: "array" - description: "Specifies scheduled tasks." - items: - $ref: "#/definitions/ScheduledTaskDetail" - description: "Response parameters" - ScheduledTaskDetail: - type: "object" - properties: - task_id: - type: "string" - description: "Specifies the AS scheduled task ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - scaling_group_id: - type: "string" - description: "Specifies the AS group ID." - pattern: "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}" - name: - type: "string" - description: "Specifies the AS scheduled task name." - minLength: 1 - maxLength: 64 - scheduled_policy: - description: "Specifies the periodic or point-in-time for task." - $ref: "#/definitions/ScheduledTaskPolicy" - instance_number: - description: "Specifies the max and min instance number for the AS group." - $ref: "#/definitions/IntegerRange" - create_time: - type: "string" - description: "Specifies the time when an AS scheduled task was created. The time format complies with UTC." - tenant_id: - type: "string" - domain_id: - type: "string" - update_time: - type: "string" - description: "scheduled task description" - PutWarmPoolOption: - type: "object" - properties: - min_capacity: - type: "integer" - format: "int32" - description: "The minimum capacity of the warm pool must be filled out simultaneously with the maximum capacity, or neither should be filled out. When filling out the minimum and maximum capacities of the warm pool, they must be equal." - max_capacity: - type: "integer" - format: "int32" - description: "The maximum capacity of the warm pool must be filled out, and the minimum and maximum capacities must either be filled out simultaneously or not at all. When filling out the minimum and maximum capacities of the warm pool, they must be equal." - instance_init_wait_time: - type: "integer" - format: "int32" - description: "Instance initialization waiting time, unit: seconds" - WarmPoolResult: - type: "object" - properties: - warm_pool: - description: "Basic Information of Warm Pool" - $ref: "#/definitions/WarmPoolInfo" - WarmPoolInfo: - type: "object" - properties: - min_capacity: - type: "integer" - format: "int32" - description: "Minimum capacity of the warm pool" - max_capacity: - type: "integer" - format: "int32" - description: "Maximum capacity of the warm pool" - instance_init_wait_time: - type: "integer" - format: "int32" - description: "Waiting time for instance initialization" - status: - type: "string" - description: "Warm Pool State" - WarmPoolInstance: - type: "object" - properties: - id: - type: "string" - description: "Warm Pool Instance ID" - instance_id: - type: "string" - description: "Corresponding virtual machine ID" - name: - type: "string" - description: "Name of the Warm Pool Instance" - status: - type: "string" - description: "Status of Warm Pool Instance" - WarmPoolInstancesResult: - type: "object" - properties: - page_info: - description: "Pagination Information" - $ref: "#/definitions/PageInfo" - warm_pool_instances: - type: "array" - description: "Warm Pool Instance List" - items: - $ref: "#/definitions/WarmPoolInstance"