GetInstanceJob-阿里云帮助中心

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/v1/instancejobs/{InstanceJobId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
InstanceJobId	string	Yes	The job ID.	12345

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	1e195c5116124202371861018d5bde
Status	string	The status of the job. Valid values: Creating: The job is being created. Updating: The job is being updated. Deleting: The job is being deleted. Successful: The job completed successfully (a final state). Failed: The job failed (a final state).	Successful
ReasonMessage	string	A message providing details about the job.	workspace-example
GmtCreateTime	string	The creation time in UTC, in ISO 8601 format.	2021-01-21T17:12:35.232Z
Type	string	The job type. Valid values: CreateWorkspaceCustomRole UpdateWorkspaceCustomRole DeleteWorkspaceCustomRole	CreateWorkspaceCustomRole
InstanceJobId	string	The job ID.	CreateWorkspaceCustomRole-role-*abc*****
InstanceId	string	The instance ID. For example, if a job creates a custom role, this parameter returns the corresponding role ID.	***12qb3***

Examples

Success response

JSON format

{
  "RequestId": "1e195c5116124202371861018d5bde",
  "Status": "Successful",
  "ReasonMessage": "workspace-example",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "Type": "CreateWorkspaceCustomRole",
  "InstanceJobId": "CreateWorkspaceCustomRole-role-***abc*******\n",
  "InstanceId": "*****12qb3*****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.