GetServiceFuncStatus - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

Retrieves the service configuration status.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sysom:GetServiceFuncStatus

get

*All Resource

*

None

Request syntax

GET /api/v1/func-switch/get-service-func-status HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
params	object	Yes	The diagnostic parameters. Different types of diagnostics require different diagnostic parameters. You can use this field to filter records whose parameters match the specified values.
function_name	string	Yes	The feature name.	mullprof
instance	string	No	The instance ID.	i-2zei55fwj8nnu31h3z46
uid	string	No	The user ID.	1338904783509062
service_name	string	Yes	The service name.	livetrace
channel	string	Yes	The channel name.	ecs

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. `code == Success` indicates that the authorization is successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.	Success
data	object	The response data.
args	object	The configuration parameters.
add_cmd	string	The configuration process.	java
cpu	string	The ONCPU tracing switch.	true
java_store_path	string	The storage path.	/tmp/sysom/java-profiler
locks	string	The lock tracing switch.	true
loop	integer	The tracing cycle.	-1
mem	string	The memory tracing switch.	true
system_profiling	string	The system profiling switch.	true
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": {
    "args": {
      "add_cmd": "java",
      "cpu": "true",
      "java_store_path": "/tmp/sysom/java-profiler",
      "locks": "true",
      "loop": -1,
      "mem": "true",
      "system_profiling": "true"
    }
  },
  "message": "\n",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.