Obtaining Component Configuration Information
Function
This API is used to obtain information about the application, environment, and enterprise project to which all components belong.
Authorization Information
Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
- If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
- If you are using identity policy-based authorization, the permission listed below is required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
servicestage:app:listComponent
list
-
-
servicestage:app:list
-
URI
GET /v3/{project_id}/cas/components/filterOptions
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Tenant's project ID. See Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Definition Message body type (or format). Constraints N/A Range application/json;charset=utf8 Default Value N/A |
| X-Auth-Token | Yes | String | Definition API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication. Constraints N/A Range N/A Default Value N/A |
Response
| Parameter | Type | Description |
|---|---|---|
| filter_options | Object | Definition Component information parameter. See Table 4. |
| Parameter | Type | Description |
|---|---|---|
| applications | Array of objects | Definition Application information. See Table 5. |
| enterprise_projects | Array of strings | Definition Enterprise project information, which is the ID list of enterprise projects used by the component. Range N/A |
| environments | Array of objects | Definition Environment information. See Table 6. |
Example Request
None
Example Response
{
"filter_options": {
"environments": [
{
"label": "env-echotest-nodel",
"id": "82005bc2-35d3-4fe1-87a8-4a1e1686f261"
}
],
"applications": [
{
"label": "wuzhiheng",
"id": "f190e324-6dd8-4c97-ba21-53deafab7395"
}
],
"enterprise_projects": [
"0"
]
}
} Status Code
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
Error Code
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot