Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.
Authorization requires the following IAM permission on the specified resource parent:
bigtable.appProfiles.list
Query parameters
Parameters
pageSize
integer
Maximum number of results per page.
A pageSize of zero lets the server choose the number of items to return. A pageSize which is strictly positive will return at most that many items. A negative pageSize will cause an error.
Following the first request, subsequent paginated calls are not required to pass a pageSize. If a pageSize is set in subsequent calls, it must match the pageSize given in the first request.
pageToken
string
The value of nextPageToken returned by a previous call.
Request body
The request body must be empty.
Response body
Response message for BigtableInstanceAdmin.ListAppProfiles.
If successful, the response body contains data with the following structure:
Set if not all app profiles could be returned in a single response. Pass this value to pageToken in another request to get the next page of results.
failedLocations[]
string
Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from appProfiles. Values are of the form projects/<project>/locations/<zoneId>
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of app profiles within a specified instance using a \u003ccode\u003eGET\u003c/code\u003e request to the provided URL.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required and specifies the instance, with the option to use \u003ccode\u003e'-'\u003c/code\u003e to list app profiles for all instances within a project, but also requires the \u003ccode\u003ebigtable.appProfiles.list\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eQuery parameters like \u003ccode\u003epageSize\u003c/code\u003e (for controlling the number of results per page) and \u003ccode\u003epageToken\u003c/code\u003e (for pagination) can be used to refine the list of results.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of \u003ccode\u003eappProfiles\u003c/code\u003e, a \u003ccode\u003enextPageToken\u003c/code\u003e for subsequent paginated requests, and a \u003ccode\u003efailedLocations\u003c/code\u003e array for locations from which data could not be retrieved.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this endpoint requires one of several specified OAuth scopes related to Bigtable administration.\u003c/p\u003e\n"]]],[],null,["# Method: projects.instances.appProfiles.list\n\nLists information about app profiles in an instance.\n\n### HTTP request\n\n`GET https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*}/appProfiles`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for BigtableInstanceAdmin.ListAppProfiles.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/bigtable.admin`\n- `https://www.googleapis.com/auth/bigtable.admin.cluster`\n- `https://www.googleapis.com/auth/bigtable.admin.instance`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin.cluster`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
