GetApprovalProcess-阿里云帮助中心

Retrieves the details of an approval process for your Alibaba Cloud account.

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

csas:GetApprovalProcess

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProcessId	string	Yes	The approval process ID. For more information, see ListApprovalProcesses to query a list of approval processes. ListApprovalProcesses: Queries a list of approval processes.	approval-process-fcc351b8a95b****

Response elements

Element	Type	Description	Example
	object	Schema of response.
RequestId	string	The ID of this request.	C81E0B4B-AAEB-5FDD-B27E-3F5AF7EBD7EF
Process	object	The approval process.
CreateTime	string	The creation time of the approval process.	2022-10-25 10:44:09
ProcessId	string	The approval process ID.	approval-process-35ee09077ee9****
ProcessName	string	The name of the approval process.	测试
Description	string	The description of the approval process.	这是一个审批流程
ProcessNodes	array<object>	A list of approval nodes.
	array<object>	A list of approvers for the node.
	object	The approver for the node.
SaseUserId	string	The approver ID.	su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Username	string	The approver username.	王先生
DomainWhitelistPolicies	object	A list of policies associated with the domain whitelist.
SchemaId	string	The approval template ID.	approval-schema-090134f1ebff****
PolicyIds	array	A list of domain whitelist policy IDs.
	string	The domain whitelist policy ID.	ladp-27a4fedf5e73****
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping table.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
DomainBlacklistPolicies	object	A list of policies associated with the domain blacklist.
SchemaId	string	The approval template ID.	approval-schema-090134f1ebff****
PolicyIds	array	A list of domain blacklist policy IDs.
	string	The domain blacklist policy ID.	ladp-27a4fedf5e73****
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
SoftwareBlockPolicies	object	A list of policies associated with software disablement.
SchemaId	string	The approval template ID.	approval-schema-090134f1ebff****
PolicyIds	array	A list of software disablement policy IDs.
	string	The software disablement policy ID.	pid-6d6ad77d5b52****
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
DeviceRegistrationPolicies	object	A list of policies associated with device registration.
SchemaId	string	The approval template ID.	approval-schema-090134f1ebff****
PolicyIds	array	A list of device registration policy IDs.
	string	The device registration policy ID.	reg-policy-63b2f1844b86****
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
AppUninstallPolicies	object	A list of policies associated with client uninstallation.
SchemaId	string	The approval template ID.	approval-schema-090134f1ebff****
PolicyIds	array	A list of client uninstallation policy IDs.
	string	The client uninstallation policy ID.	auto-boot-anti-uninstall-5919f8afff47****
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object	Field mapping item.
SystemField	string	System field.	名称
DisplayField	string	Display field.	名称
DisplayFieldValue	string
DlpSendPolicies	object	A list of policies associated with file outbound transfer.
SchemaId	string	The approval template ID.	approval-schema-090134f1ebff****
PolicyIds	array	A list of file outbound transfer policy IDs.
	string	The file outbound transfer policy ID.	17**
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
PeripheralBlockPolicies	object	A list of policies associated with peripheral control.
SchemaId	string	The approval template ID.	approval-schema-090134f1ebff****
PolicyIds	array	A list of peripheral control policy IDs.
	string	The peripheral control policy ID.	17**
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
EndpointHardeningPolicies	object	Endpoint hardening policies.
SchemaId	string	Template ID.
PolicyIds	array	Policy ID.
	string
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
SoftwareHardeningPolicies	object	Software hardening policies.
SchemaId	string	Template ID.
PolicyIds	array	Policy ID.
	string
ExternalProcessId	string	The external process ID.
FieldMap	array<object>	Field mapping.
	object
SystemField	string	System field.
DisplayField	string	Display field.
DisplayFieldValue	string
ApprovalType	integer	The approval type.
ExternalConfig	string	External configuration.
EventLabel	string	Label.

Examples

Success response

JSON format

{
  "RequestId": "C81E0B4B-AAEB-5FDD-B27E-3F5AF7EBD7EF",
  "Process": {
    "CreateTime": "2022-10-25 10:44:09",
    "ProcessId": "approval-process-35ee09077ee9****",
    "ProcessName": "测试",
    "Description": "这是一个审批流程",
    "ProcessNodes": [
      [
        {
          "SaseUserId": "su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****",
          "Username": "王先生"
        }
      ]
    ],
    "DomainWhitelistPolicies": {
      "SchemaId": "approval-schema-090134f1ebff****",
      "PolicyIds": [
        "ladp-27a4fedf5e73****"
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "DomainBlacklistPolicies": {
      "SchemaId": "approval-schema-090134f1ebff****",
      "PolicyIds": [
        "ladp-27a4fedf5e73****"
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "SoftwareBlockPolicies": {
      "SchemaId": "approval-schema-090134f1ebff****",
      "PolicyIds": [
        "pid-6d6ad77d5b52****"
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "DeviceRegistrationPolicies": {
      "SchemaId": "approval-schema-090134f1ebff****",
      "PolicyIds": [
        "reg-policy-63b2f1844b86****"
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "AppUninstallPolicies": {
      "SchemaId": "approval-schema-090134f1ebff****",
      "PolicyIds": [
        "auto-boot-anti-uninstall-5919f8afff47****"
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "名称",
          "DisplayField": "名称",
          "DisplayFieldValue": ""
        }
      ]
    },
    "DlpSendPolicies": {
      "SchemaId": "approval-schema-090134f1ebff****",
      "PolicyIds": [
        "17**"
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "PeripheralBlockPolicies": {
      "SchemaId": "approval-schema-090134f1ebff****",
      "PolicyIds": [
        "17**"
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "EndpointHardeningPolicies": {
      "SchemaId": "",
      "PolicyIds": [
        ""
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "SoftwareHardeningPolicies": {
      "SchemaId": "",
      "PolicyIds": [
        ""
      ],
      "ExternalProcessId": "",
      "FieldMap": [
        {
          "SystemField": "",
          "DisplayField": "",
          "DisplayFieldValue": ""
        }
      ]
    },
    "ApprovalType": 0,
    "ExternalConfig": "",
    "EventLabel": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.