v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-135982176.0 KB
apps

Updates the configuration of the specified service.

patch/v1/apps/{appsId}/services/{servicesId}

Path parameters

appsIdstring required

Part of name. Required. Name of the resource to update. Example: apps/myapp/services/default.

servicesIdstring required

Part of name. See documentation of appsId.

Query parameters

migrateTrafficboolean

Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).

updateMaskstring

Required. Standard field mask for the set of fields to be updated.

Request body

generatedCustomerMetadataobject

Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest

labelsobject

A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.

namestring

Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly

idstring

Output only. Relative name of the service within the application. Example: default.@OutputOnly

Response

Successful response