ListResourceTypeRegistrations - Resource Orchestration Service

Queries the registration records of a resource.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ros:ListResourceTypeRegistrations	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
EntityType	string	No	The entity type. Set the value to Module.	Module
ResourceType	string	No	The resource type. The resource type can contain letters, digits, colons (:), and asterisks (). You can use an asterisk () to perform a fuzzy match.	MODULE::MyOrganization::MyService::MyUsecase
RegistrationId	string	No	The ID of the registration record.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
Status	string	No	The registration state. Valid values: IN_PROGRESS COMPLETE FAILED	COMPLETE
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Registrations	array<object>	The registration records of the resource.
	object
RegistrationId	string	The ID of the registration record.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
EntityType	string	The entity type. Only Module may be returned.	Module
ResourceType	string	The resource type.	MODULE::MyOrganization::MyService::MyUsecase
VersionId	string	The version ID.	v1
Status	string	The registration state. Valid values: IN_PROGRESS: The registration is in progress. COMPLETE: The registration is successful. FAILED: The registration failed.	COMPLETE
StatusReason	string	The reason for the state.	Module is created successfully
CreateTime	string	The creation time. The time is displayed in UTC. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format.	2023-03-02T07:28:35
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of registration records.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Registrations": [
    {
      "RegistrationId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****\n",
      "EntityType": "Module",
      "ResourceType": "MODULE::MyOrganization::MyService::MyUsecase",
      "VersionId": "v1",
      "Status": "COMPLETE",
      "StatusReason": "Module is created successfully",
      "CreateTime": "2023-03-02T07:28:35"
    }
  ],
  "PageNumber": 1,
  "TotalCount": 1
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-20	The response structure of the API has changed	View Change Details
2023-07-20	The response structure of the API has changed	View Change Details