All Products
Search

This Product

    Resource Orchestration Service:ListResourceTypeRegistrations

    Document Center

    Resource Orchestration Service:ListResourceTypeRegistrations

    Last Updated:Jun 17, 2026

    Queries a list of resource registration records.

    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

    ros:ListResourceTypeRegistrations

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    EntityType

    string

    No

    The entity type. Valid values: Module.

    Valid values:

    • Module :

      Module

    Module
    ResourceType

    string

    No

    The resource type. The value can contain uppercase and lowercase letters, digits, colons (:), and asterisks (*). If you use an asterisk, fuzzy match is performed.

    MODULE::MyOrganization::MyService::MyUsecase

    RegistrationId

    string

    No

    The registration ID.

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    Status

    string

    No

    The registration status. Valid values:

    • IN_PROGRESS: In progress.

    • COMPLETE: Succeeded.

    • FAILED: Failed.

    Valid values:

    • IN_PROGRESS :

      IN_PROGRESS

    • COMPLETE :

      COMPLETE

    • FAILED :

      FAILED

    COMPLETE
    PageNumber

    integer

    No

    The page number for paging. Minimum value: 1. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page for paging. Valid values: 1 to 50. Default value: 10.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    B288A0BE-D927-4888-B0F7-B35EF84B6E6
    Registrations

    array<object>

    The list of resource registration records.

    object

    The resource registration record.

    RegistrationId

    string

    The registration ID.

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****

    EntityType

    string

    The entity type. Valid values: Module.

    Valid values:

    • Module :

      Module

    Module
    ResourceType

    string

    The resource type.

    MODULE::MyOrganization::MyService::MyUsecase
    VersionId

    string

    The version ID.

    v1
    Status

    string

    The registration status. Valid values:

    • IN_PROGRESS: In progress.

    • COMPLETE: Succeeded.

    • FAILED: Failed.

    Valid values:

    • IN_PROGRESS :

      IN_PROGRESS

    • COMPLETE :

      COMPLETE

    • FAILED :

      FAILED

    COMPLETE
    StatusReason

    string

    The reason for the status.

    Module is created successfully
    CreateTime

    string

    The time when the registration record was created. The time is displayed in UTC+0 based on the ISO 8601 standard but without the Z suffix. Format: YYYY-MM-DDThh:mm:ss.

    2023-03-02T07:28:35
    PageNumber

    integer

    The page number for paging.

    1
    TotalCount

    integer

    The total number of registration records.

    1

    Examples

    Success response

    JSON format

    {
  "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.