Skip to content

Latest commit

 

History

History
456 lines (344 loc) · 24.9 KB

remove.md

File metadata and controls

456 lines (344 loc) · 24.9 KB
Raw
title description position category
Remove commands
Remove commands
3
Build&Deploy

Remove commands

The remove commands are used to remove resources that are deployed.

⚠️ Note: Resources may not be restored once they are removed. Proceed with caution when you run the remove commands.

Command description

You can run the remove -h or remove --help command to obtain the help documentation for the remove commands.

The remove commands consist of nine subcommands:

Parameter description

Parameter Abbreviation Required in YAML mode Description
assume-yes y No By default, y is selected.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

If the resource description file (YAML) exists, you can run the s remove command to delete resources. Sample command output:

Service [myService] deleted successfully.
Function [myFunction] deleted successfully.

⚠️ Note:

  • Executing s remove is equivalent to executing s remove ondemand, s remove provision, s remove alias, s remove version, s remove trigger, s remove function, s remove in sequence service;
  • If the parameter -y/--assume-yes is used, then there will be no interactive forced deletion of all resources under the service, please use this parameter with caution; Case: If there is a service in Shanghai area, there are two functions under the service, and only the service and one of the functions are configured in Yaml
  • If s remove is executed, it will prompt the next two functions of this service, whether to delete all functions;
  • If s remove -y is executed, both functions and services are forcibly removed;
  • If you just want to remove the current Yaml-declared function, you can do s remove function

remove service command

You can run the remove service command to delete a specified service.

You can run the remove service -h or remove service --help command to obtain the help documentation for the remove service command.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
service-name - No Yes The name of the service.
assume-yes y No No By default, y is selected.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove service command to delete the specified service.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove service --region cn-hangzhou --service-name fc-deploy-service.

Sample command output:

Service [fc-deploy-service] deleted successfully.

remove function commands

The remove function command is a command to delete the specified function.

When executing the command remove function -h/remove function --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
service-name - No Yes The name of the service.
function-name - No Yes The name of the function.
assume-yes y No No By default, y is selected.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove function command to delete the specified function.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove function --region cn-hangzhou --service-name fc-deploy-service --function-name fc-deploy-function.

Sample command output:

Function [fc-deploy-function] deleted successfully.

remove trigger command

The remove trigger command is a command to delete the specified trigger.

When executing the command remove trigger -h/remove trigger --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
service-name - No Yes The name of the service.
function-name - No Yes The name of the function.
trigger-name - No Yes The name of the trigger.
assume-yes y No No By default, y is selected.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove trigger command to delete all triggers that are configured in the resource description file (YAML). You can configure the --trigger-name triggerName parameter to specify the trigger that you want to delete.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove trigger --region cn-hangzhou --service-name fc-deploy-service --function-name fc-deploy-function --trigger-name fc-deploy-trigger.

Sample command output:

Trigger [fc-deploy-trigger] deleted successfully.

remove domain command

The remove domain command is a command to delete the specified custom domain name.

When executing the command remove domain -h/remove domain --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
domain-name - No Yes The custom domain name.
assume-yes y No No By default, y is selected.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove domain command to delete all custom domain names that are configured in the resource description file (YAML). You can configure the --domain domain parameter to specify the custom domain name that you want to delete.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove domain --region cn-hangzhou --domain-name anycodes.cn.

Sample command output:

Custom domain [anycodes.cn] deleted successfully.

remove version command

The remove version command is a command for the user to delete the specified released version.

When executing the command remove version -h/remove version --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
service-name - No Yes The name of the service.
version-id - Yes Yes The ID of the version.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove version --version-id versionId command to delete the version with the specified versionId.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove version --region cn-hangzhou --service-name fc-deploy-service --version-id 1.

Sample command output:

VersionId [1] deleted successfully.

remove alias command

The remove alias command is a command to remove the specified service alias.

When executing the command remove alias -h/remove alias --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
service-name - No Yes The name of the service.
alias-name - Yes Yes The alias of the service.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove alias --alias-name aliasName command to delete the specified alias.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove alias --region cn-hangzhou --service-name fc-deploy-service --alias-name pre.

Sample command output:

AliasName [pre] deleted successfully.

remove provision commans

The remove provision command is a command to remove reserved resources.

When executing the command remove provision -h/remove provision --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
service-name - No Yes The name of the service.
function-name - No No The name of the function. It needs to be used together with qualifier.
qualifier No No The version or alias of the service. Only LATEST is supported for the version. If you specify a value for the qualifier parameter, only reserved resources that are specified by using the qualifier parameter are deleted. If you do not specify a value for the qualifier parameter, reserved resources of all versions of the service are deleted.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove provision --qualifier qualifier command to delete the reserved instances.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove provision --region cn-hangzhou --service-name fc-deploy-service --qualifier release.

Sample command output:

Proivision qualifier [release] deleted successfully.

remove ondemand command

The remove ondemand command is a command to delete the ondemand resource of the specified function.

When executing the command remove ondemand -h/remove ondemand --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
service-name - No Yes The name of the service.
function-name - No No The name of the function. It needs to be used together with qualifier.
qualifier - No No The version or alias of the service. Only LATEST is supported for the version. If you specify a value for the qualifier parameter, only on-demand resources that are specified by using the qualifier parameter are deleted. If you do not specify a value for the qualifier parameter, on-demand resources of all versions of the service are deleted.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove ondemand command to delete the specified on-demand resources.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region and the name of the service. Example: s cli fc remove ondemand.

Sample command output:

Ondemand [*] deleted successfully.

remove layer command

The remove layer command is a command to remove the specified layer version.

When executing the command remove layer -h/remove layer --help, you can get help documentation.

Parameter description

Parameter Abbreviation Required in YAML mode Required in CLI mode Description
region - No Yes The region of the service. Valid values: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, and ap-south-1.
layer-name - No Yes The name of the layer.
version-id - No No The version that you want to delete. If you specify a value for the --version-id parameter, only the version that is specified by using the --version-id parameter is deleted. If you do not specify a value for the --version-id parameter, all versions of the specified layer are deleted.

The current command also supports some global parameters (such as -a/--access, --debug, etc.). For details, please refer to Serverless Devs global parameters document

Examples

  • If the resource description file (YAML) exists, you can run the s remove layer --layer-name layerName command to delete all versions of the specified layer.
  • If the resource description file (YAML) does not exist (only the CLI mode is available), you need to specify the region of the service. Example: s cli fc remove layer --region cn-hangzhou --layer-name demo.

Sample command output:

Layer [demo] deleted successfully.

Permissions-and-policies

  • s remove/s remove service： 
    {
    "Statement": [
        {
            "Action": [
                "fc:ListOnDemandConfigs",
                "fc:DeleteFunctionOnDemandConfig",
                "fc:ListProvisionConfigs",
                "fc:PutProvisionConfig",
                "fc:ListAliases",
                "fc:DeleteAlias",
                "fc:ListServiceVersions",
                "fc:DeleteServiceVersion",
                "fc:ListTriggers",
                "fc:DeleteTrigger",
                "fc:ListFunctions",
                "fc:DeleteFunction",
                "fc:DeleteService"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ],
    "Version": "1"
}
  • s remove function： 
    {
    "Statement": [
        {
            "Action": [
                "fc:ListTriggers",
                "fc:DeleteTrigger",
                "fc:DeleteFunction"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ],
    "Version": "1"
}
  • s remove trigger： 
    {
    "Statement": [
        {
            "Action": [
                "fc:DeleteTrigger"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ],
    "Version": "1"
}
  • s remove version： System policy：AliyunFCReadOnlyAccess 
    {
    "Version": "1",
    "Statement": [
        {
            "Action": "fc:DeleteServiceVersion",
            "Effect": "Allow",
            "Resource": "acs:fc:<region>:<account-id>:services/<serviceName>/versions/<version-id>"
        }
    ]
}
  • s remove provision： System policy：AliyunFCReadOnlyAccess 
    {
    "Version": "1",
    "Statement": [
        {
            "Action": "fc:PutProvisionConfig",
            "Effect": "Allow",
            "Resource": "acs:fc:<region>:<account-id>:services/services/<serviceName>.<qualifier>/functions/<functionName>"
        }
    ]
}
  • s remove ondemand： System policy：AliyunFCReadOnlyAccess 
    {
    "Version": "1",
    "Statement": [
        {
            "Action": "fc:DeleteFunctionOnDemandConfig",
            "Effect": "Allow",
            "Resource": "acs:fc:<region>:<account-id>:services/services/<serviceName>.<qualifier>/functions/<functionName>"
        }
    ]
}
  • s remove layer： System policy：AliyunFCReadOnlyAccess 
    {
  "Version": "1",
  "Statement": [
      {
          "Action": "fc:DeleteLayerVersion",
          "Effect": "Allow",
          "Resource": "acs:fc:<region>:<account-id>:layers/<layerName>/versions/*"
      }
  ]
}