ListParameters - CloudOps Orchestration Service - Centro de documentación de Alibaba Cloud

Consulta los parámetros y los parámetros comunes. Admite varios métodos de consulta.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

oos:ListParameters

list

*Parámetro.

acs:oos:{#regionId}:{#accountId}:parameter/*

oos:TLSVersion

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región.	cn-hangzhou
Name	string	No	El nombre del parámetro. El parámetro Name de esta operación admite coincidencia aproximada.	MyParameter
MaxResults	integer	No	El número de entradas por página. Valores válidos: de 10 a 100. Valor predeterminado: 50.	50
NextToken	string	No	El token de paginación.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
SortField	string	No	El campo que se utiliza para ordenar los resultados de la consulta. Valores válidos: Name: el nombre del parámetro. CreatedDate: la hora de creación.	Name
SortOrder	string	No	El orden de clasificación. Valores válidos: Ascending: orden ascendente. Descending (predeterminado): orden descendente.	Descending
Type	string	No	El tipo de parámetro. Valores válidos: String StringList	String
Path	string	No	La ruta del parámetro. Por ejemplo, si Name es /path/path1/Myparameter, el valor contiene la ruta del parámetro.	/path1/path2/
Recursive	boolean	No	Especifica si se debe consultar la ruta del parámetro de forma recursiva. Valor predeterminado: false.	false
Tags	object	No	Las etiquetas.	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmxsn4m4******
ShareType	string	No	Especifica si el parámetro es un parámetro común. Valores válidos: Public Private Valor predeterminado: Private.	Private

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
NextToken	string	El token de paginación.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb
RequestId	string	El ID de la solicitud.	A81E4B2E-6B33-4BAE-9856-55DB7C893E01
TotalCount	integer	El número total de entradas devueltas.	5
MaxResults	integer	El número de entradas por página.	50
Parameters	array<object>	La información de los parámetros.
	array<object>
Type	string	El tipo de parámetro.	String
UpdatedDate	string	La hora en que se actualizó el parámetro, en formato ISO 8601 (UTC).	2020-09-01T08:01:43Z
UpdatedBy	string	El usuario que actualizó el parámetro.	root(130900000)
Tags	object	Las etiquetas.	{"k1": "v1", "k2": "v2"}
Description	string	La descripción del parámetro.	parámetro
CreatedBy	string	El usuario que creó el parámetro.	root(130900000)
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmxsn4m4******
CreatedDate	string	La hora en que se creó el parámetro, en formato ISO 8601 (UTC).	2020-09-01T08:01:43Z
ParameterVersion	string	El número de versión del parámetro.	1
Name	string	El nombre del parámetro.	MyParameter
Id	string	El ID del parámetro.	p-4c4b401cab6747xxxxxx
ShareType	string	El tipo de uso compartido del parámetro.	Private

Ejemplos

Respuesta exitosa

JSON Formato

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb",
  "RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
  "TotalCount": 5,
  "MaxResults": 50,
  "Parameters": [
    {
      "Type": "String",
      "UpdatedDate": "2020-09-01T08:01:43Z",
      "UpdatedBy": "root(130900000)",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Description": "parameter",
      "CreatedBy": "root(130900000)",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedDate": "2020-09-01T08:01:43Z",
      "ParameterVersion": "1",
      "Name": "MyParameter",
      "Id": "p-4c4b401cab6747xxxxxx",
      "ShareType": "Private"
    }
  ]
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.