GetProcessDefinition - DataWorks: Central de Documentação do Alibaba Cloud

Obtém a política de aprovação para um determinado ID de definição de processo.

Descrição da operação

Solicitação

Esta API obtém os detalhes de uma definição de processo de aprovação específica usando o parâmetro ID.
O parâmetro ID é obrigatório e deve ser um ID de definição de processo válido.
A resposta inclui as propriedades básicas da definição do processo de aprovação, condições de regra, configurações do serviço de notificação e nós de aprovação.
Uma solicitação bem-sucedida retorna o objeto completo da definição do processo. Uma solicitação com falha retorna um código de erro e uma mensagem para solução de problemas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID da definição de processo.	f0d6d578-a305-40ac-ba1e-0a09f64cbc69

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação da API.	0bc5df3a17***903790e8e8a
ProcessDefinition	object	A definição de processo.
Id	string	O ID da definição de processo.	210001039767
Name	string	O nome da definição de processo.	MaxCompute 表审批
Description	string	A descrição do processo de negócios.	订单业务数据审批流程
Type	string	O tipo de definição de processo. Valores válidos: MaxCompute DataService Extension Hologres DlfV1 (Criação personalizada não suportada). EMR (Criação personalizada não suportada). DataAssetGovernance (Criação personalizada não suportada). Lindorm (Criação personalizada não suportada). StarRocks (Criação personalizada não suportada). DlfNext (Criação personalizada não suportada). DataWorks (Criação personalizada não suportada).	MaxCompute
SubType	string	O subtipo: Table Column Database Schema Default.	Table
IsSystem	boolean	A política padrão do sistema.	false
Enabled	boolean	Ativar.	true
RuleConditions	array<object>	A lista de condições de regra.
	object	A condição de regra.
Type	string	The condition type. This is an enumeration: `odpsProject`, `hologresInstanceId` `sensibleLevel`, `tableGuid`, `projectId`	odpsProject
Expression	string	A conditional expression is in the format `((#type=='typeValue'))`, such as `((#odpsProject=='PX_BEIJING_TEST'))`.	((#odpsProject=='PX_BEIJING_TEST'))
Scope	string	rule effective stage: `Deployment` determines whether an application matches this approval policy upon submission. `Running` is used to determine whether an approval process is approval-free. This feature is supported only for the MaxCompute type.	Deployment
NotificationServices	array<object>	A declaração do serviço de notificação.
	object	O serviço de notificação.
Channel	string	Notification channel, an enumeration: Mail Sms DingRobot Weixin	DingRobot
Extension	string	Additional information in JSON format, such as `{"atAll":"true"}` to specify whether to @all members.	{"atAll":"true"}
Receiver	string	You must specify WebhookUrl when Channel is DingRobot or Weixin.	https://dingtalk.com
ApprovalNodes	array<object>	A lista de nós de aprovação.
	array<object>	O nó de aprovação.
Id	string	Node ID	7a809b6a-2a62-4c6c-9c23-c2a145e3877d
Name	string	Node Name	default-name
AccountType	string	Node approver type: DataWorksProjectRole project role DataWorksProjectMember project member TableAdministrator table administrator TableOrProjectAdministrator Table or project administrator AliyunResourceOwner Alibaba Cloud account MaxComputeRole MC Administrator DLFAdmin and DlfLegacy administrator DLFNext Administrator TenantRole tenant role EmrAdministrator Emr administrator LindormAdministrator Lindorm Administrator AliyunRamUser RAM user	TableOrProjectAdministrator
Assignees	array	`AccountType` has different semantics for different types: DataWorksProjectMember specifies the project member's UserId. DataWorksProjectRole specifies the code of the project role. MaxComputeRole specifies the MaxCompute role. TenantRole specifies the tenant role code. AliyunRamUser specifies the RAM user ID.
	string	Approver	213463068144525171
ExtensionProperties	object	When `AccountType` is set to different types, you must provide different additional declarations: DataWorksProjectMember: The key is projectId, and the value is the UserIds of project members, separated by commas. MaxComputeRole: The key is a MaxCompute project and the value is a role name in MaxCompute. Multiple role names are separated by a comma.
	any	Additional Information	{ "449656": "role_project_admin,role_project_pe" }

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc5df3a17***903790e8e8a",
  "ProcessDefinition": {
    "Id": "210001039767",
    "Name": "MaxCompute 表审批",
    "Description": "订单业务数据审批流程",
    "Type": "MaxCompute",
    "SubType": "Table",
    "IsSystem": false,
    "Enabled": true,
    "RuleConditions": [
      {
        "Type": "odpsProject",
        "Expression": "((#odpsProject=='PX_BEIJING_TEST'))",
        "Scope": "Deployment"
      }
    ],
    "NotificationServices": [
      {
        "Channel": "DingRobot",
        "Extension": "{\"atAll\":\"true\"}",
        "Receiver": "https://dingtalk.com"
      }
    ],
    "ApprovalNodes": [
      {
        "Id": "7a809b6a-2a62-4c6c-9c23-c2a145e3877d",
        "Name": "default-name",
        "AccountType": "TableOrProjectAdministrator",
        "Assignees": [
          "213463068144525171"
        ],
        "ExtensionProperties": {
          "key": "{\n        \"449656\": \"role_project_admin,role_project_pe\"\n      }"
        }
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.